From bd108573307509f0e98e75fc983eb4f260bb3e29 Mon Sep 17 00:00:00 2001 From: Strahinja Val Markovic Date: Sat, 2 Feb 2013 13:38:04 -0800 Subject: [PATCH] Adding command descriptions to README --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index 7522580a..52a4df2e 100644 --- a/README.md +++ b/README.md @@ -381,6 +381,34 @@ a single key mapping is provided by another (very small) Vim plugin called TODO: extending the semantic engine for other langs +Commands +-------- + +### The `YcmForceCompileAndDiagnostics` command + +Calling this command will force YCM to immediately recompile your file +and display any new diagnostics it encounters. Do note that recompilation with +this command may take a while and during this time the Vim GUI _will_ be +blocked. + +You may want to map this command to a key; try putting `nnoremap +:YcmForceCompileAndDiagnostics` in your vimrc. + +### The `YcmDiags` command + +Calling this command will fill Vim's `locationlist` with errors or warnings if +any were detected in your file and then open it. + +A better option would be to use Syntastic which will keep your `locationlist` +up to date automatically and will also show error/warning notifications in Vim's +gutter. + +### The `YcmDebugInfo` command + +This will print out various debug information for the current file. Useful to +see what compile commands will be used for the file if you're using the semantic +completion engine. + Options -------