Update README with basic information and let Vim understand the .ct fileformat

This commit is contained in:
Viktor Varland 2016-01-28 09:58:56 +01:00
parent 188269b6f6
commit 2f9d6bc011
2 changed files with 15 additions and 0 deletions

14
README
View file

@ -0,0 +1,14 @@
Cluster Text
============
A Vim-plugin that allows you to write the most basic form of cluster texts based
on the work of Andreas Pålsson. The basic rules are as follows:
- Following a full stop five (5) spaces are used instead of one (1)
- Alone words at the end of a line are wrapped to the next line
- Lines should be left aligned (not justified)
- 80-90 characters per line
The full rule set is complex and involves human judgement to place the indentations
within sentences. As such, there is no simple algorythm (yet) that can be used
to place indentations while still maintaining a natural "feel" when reading the text.

1
ftdetect/clustertext.vim Normal file
View file

@ -0,0 +1 @@
au BufNewFile,BufRead *.ct set filetype=clustertext