From adc661810dce19feab297c7c3e5f5d7fb4e81cd8 Mon Sep 17 00:00:00 2001
From: wsdjeg <wsdjeg@163.com>
Date: Wed, 25 Jan 2017 20:44:05 +0800
Subject: [PATCH] Add install faq for ycm

---
 autoload/SpaceVim.vim | 19 ++++++++++++++++++-
 doc/SpaceVim.txt      | 20 +++++++++++++++++++-
 2 files changed, 37 insertions(+), 2 deletions(-)

diff --git a/autoload/SpaceVim.vim b/autoload/SpaceVim.vim
index 8f9bec153..831eff8bc 100644
--- a/autoload/SpaceVim.vim
+++ b/autoload/SpaceVim.vim
@@ -303,4 +303,21 @@ endfunction
 
 ""
 " @section FAQ, faq
-" 1. How to enable YouCompleteMe?
+" 1. How to enable YouCompleteMe? (I do not recommend to use YouCompleteMe, it
+" is too big as a vim plugin, BTW I do not like using submodule in vim plugin,
+" it is hard to manager by vim plugin manager.)
+"
+" >
+"   step 1: add `let g:spacevim_enable_ycm = 1` to custom_config, by default it
+"   should be `~/.SpaceVim.d/init.vim`.
+"
+"   step 2: Get into the directory of YouCompleteMe's author, by default it
+"   should be `~/.cache/vimfiles/repos/github.com/Valloric/`, If you find the
+"   directory `YouCompleteMe` in it, just get into it, otherwise clone
+"   YouCompleteMe repo by
+"   `git clone https://github.com/Valloric/YouCompleteMe.git`, after cloning,
+"   get into it, run `git submodule update --init --recursive`.
+"
+"   step 3: compile YouCompleteMe with the feature you want. if you just want
+"   support c family, you need run `./install.py --clang-completer`.
+" <
diff --git a/doc/SpaceVim.txt b/doc/SpaceVim.txt
index 6438091e2..dd8f5b74e 100644
--- a/doc/SpaceVim.txt
+++ b/doc/SpaceVim.txt
@@ -435,7 +435,25 @@ lang#c :
 ==============================================================================
 FAQ                                                             *SpaceVim-faq*
 
-  1. How to enable YouCompleteMe?
+  1. How to enable YouCompleteMe? (I do not recommend to use YouCompleteMe, it
+is too big as a vim plugin, BTW I do not like using submodule in vim plugin,
+it is hard to manager by vim plugin manager.)
+
+
+>
+  step 1: add `let g:spacevim_enable_ycm = 1` to custom_config, by default it
+  should be `~/.SpaceVim.d/init.vim`.
+
+  step 2: Get into the directory of YouCompleteMe's author, by default it
+  should be `~/.cache/vimfiles/repos/github.com/Valloric/`, If you find the
+  directory `YouCompleteMe` in it, just get into it, otherwise clone
+  YouCompleteMe repo by
+  `git clone https://github.com/Valloric/YouCompleteMe.git`, after cloning,
+  get into it, run `git submodule update --init --recursive`.
+
+  step 3: compile YouCompleteMe with the feature you want. if you just want
+  support c family, you need run `./install.py --clang-completer`.
+<
 
 
 vim:tw=78:ts=8:ft=help:norl: