X-Git-Url: http://nitlanguage.org diff --git a/misc/README.md b/misc/README.md index 181c047..8d09d74 100644 --- a/misc/README.md +++ b/misc/README.md @@ -37,6 +37,8 @@ Ensure that `~/.vimrc` contains * Automatic indentation * 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 @@ -93,3 +95,42 @@ 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 + +The command `:Nitdoc` searches the documentation for the word under the cursor. +The results are displayed in the preview window in order of relevance. +You can search for any word by passing it as an argument, as in `:Nitdoc modulo`. +The Nitdoc command uses the same metadata files as the omnifunc. +You may want to map the command to a shortcut by adding the following code to `~/.vimrc`. + +~~~ +" Map displaying Nitdoc to Ctrl-D +map :Nitdoc +~~~ + +## 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 :call NitGitGrep() +~~~ + +## Execute the current file + +The command `:NitExecute` calls `nit` to interpret the current file. + +If modified, the current buffer is saved to a temporary file before being executed. +This may cause failures if the current buffer imports modules relative to the source package. +In such cases, save the file before calling `:NitExecute`. + +You may want to map the command to a shortcut by adding the following code to `~/.vimrc`. + +~~~ +" Map the NitExecute function to Ctrl-F +map :NitExecute +~~~