misc: adapts gtksourceview/nit.lang to extern code use

[nit.git] / misc / README

diff --git a/misc/README b/misc/README
index 377f9b7..5166943 100644 (file)
--- a/misc/README
+++ b/misc/README
@@ -1,4 +1,30 @@
-* gtksourceview (gedit and other GTK editors)
-  To install in your home, just link (or copy) the language definition file in ~/.local/share/gtksourceview-2.0/language-specs
+# gtksourceview (gedit and other GTK editors)
+To install in your home, just link (or copy) the language definition file in ~/.local/share/gtksourceview-2.0/language-specs
 
+# vim
 
+vim is a powerful text editor.
+The misc/vim directory contains the support of nit files to vim.
+
+### Install
+
+The simpler way to install nit for vim is with [pathogen][1].
+
+    cd ~/.vim/bundle
+    ln -s /full/path/to/nit/misc/vim nit
+
+Ensure that your .vimrc contains
+
+    call pathogen#infect()
+    syntax on
+    filetype plugin indent on
+
+  [1]: https://github.com/tpope/vim-pathogen
+
+### Features
+
+ * syntax highlighting
+ * indentation
+ * syntax checker (require [Syntastic][2]).
+
+  [2]: https://github.com/scrooloose/syntastic