misc/vim: add a function to show the doc of the entity under the cursor

[nit.git] / misc / README.md

diff --git a/misc/README.md b/misc/README.md
index 181c047..1a7b97f 100644 (file)
--- a/misc/README.md
+++ b/misc/README.md
@@ -37,6 +37,7 @@ Ensure that `~/.vimrc` contains
  * Automatic indentation
  * Syntax checker (require [Syntastic][2]).
  * Autocomplete for whole projects using module importations
+ * Show documentation in preview window
 
   [2]: https://github.com/scrooloose/syntastic
 
@@ -93,3 +94,14 @@ will use general metadata in the plugin directory.
 
 The metadata files from nitpick are stored in `~/.vim/nit/`. This location can be customized with
 the environment variable `NIT_VIM_DIR`.
+
+## Documentation in preview window
+
+You can display the documentation for the entity under the cursor with `:call Nitdoc()`.
+It will use the same metadata files as the omnifunc and the preview window.
+You may want to map the function to a shortcut by adding the following code to `~/.vimrc`.
+
+~~~
+" Map displaying Nitdoc to Ctrl-D
+map <C-d> :call Nitdoc()<enter>
+~~~