summaryrefslogtreecommitdiff
path: root/Documentation/VimConfiguration.md
diff options
context:
space:
mode:
authorGunnar Beutner <gbeutner@serenityos.org>2022-10-25 21:38:30 +0200
committerLinus Groh <mail@linusgroh.de>2022-10-27 20:52:39 +0100
commit2ef1e7e634f0b15ddf68008b0c8c453fa0b4a4bc (patch)
tree40602ed6bc5b95ab3626c6450070ba679749ca8b /Documentation/VimConfiguration.md
parent83b3403b526a3d68400e32bc1fa6995908ff6413 (diff)
downloadserenity-2ef1e7e634f0b15ddf68008b0c8c453fa0b4a4bc.zip
Meta: Add configuration file for YouCompleteMe
YouCompleteMe is a plugin for Vim which provides code-completion functionality. This change adds a configuration file which makes YouCompleteMe aware of which compile flags to use with clangd.
Diffstat (limited to 'Documentation/VimConfiguration.md')
-rw-r--r--Documentation/VimConfiguration.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/Documentation/VimConfiguration.md b/Documentation/VimConfiguration.md
new file mode 100644
index 0000000000..c5303990cb
--- /dev/null
+++ b/Documentation/VimConfiguration.md
@@ -0,0 +1,12 @@
+# Vim Project Configuration
+
+Vim can be configured to use the [YouCompleteMe](https://github.com/ycm-core/YouCompleteMe)
+plugin to provide code-completion.
+
+Once you've installed the YouCompleteMe plugin you should whitelist the
+configuration file that is part of the SerenityOS repository. You can
+do this by adding the following option to your `.vimrc` file:
+
+```vim
+let g:ycm_extra_conf_globlist = ['~/serenity/.ycm_extra_conf.py']
+```