misc/vim: add a function to search for instances of the word under the cursor

[nit.git] / misc / README.md

diff --git a/misc/README.md b/misc/README.md
index 1a7b97f..1661f43 100644 (file)
--- a/misc/README.md
+++ b/misc/README.md
@@ -38,6 +38,7 @@ Ensure that `~/.vimrc` contains
  * Syntax checker (require [Syntastic][2]).
  * Autocomplete for whole projects using module importations
  * Show documentation in preview window
+ * Search declarations and usages of the word under the cursor
 
   [2]: https://github.com/scrooloose/syntastic
 
@@ -105,3 +106,14 @@ You may want to map the function to a shortcut by adding the following code to `
 " Map displaying Nitdoc to Ctrl-D
 map <C-d> :call Nitdoc()<enter>
 ~~~
+
+## Search declarations and usages of the word under the cursor
+
+The function `NitGitGrep` calls `git grep` to find declarations and usages of the word under the cursor.
+It displays the results in the preview window.
+You may want to map the function to a shortcut by adding the following code to `~/.vimrc`.
+
+~~~
+" Map the NitGitGrep function to Ctrl-G
+map <C-g> :call NitGitGrep()<enter>
+~~~