From 234fd5acb851a62de75be5bd94f4dbdb8fbb490e Mon Sep 17 00:00:00 2001 From: Ryan Leaf Date: Wed, 21 Oct 2015 18:19:27 -0400 Subject: [PATCH] Fedora documentation with required dependencies. Works on F22. --- README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) diff --git a/README.md b/README.md index 20fe3354..f4dd84c6 100644 --- a/README.md +++ b/README.md @@ -210,6 +210,52 @@ YCM comes with sane defaults for its options, but you still may want to take a look at what's available for configuration. There are a few interesting options that are conservatively turned off by default that you may want to turn on. +### Fedora Linux x64 super-quick installation + +Please refer to the full Installation Guide below; the following commands are +provided on a best-effort basis and may not work for you. + +Make sure you have Vim 7.3.598 with python2 support. Fedora 21 and later have +a Vim that's recent enough. You can see the version of Vim installed by running +`vim --version`. If the version is too old, you may need to [compile Vim +from source][vim-build] (don't worry, it's easy). + +Install YouCompleteMe with [Vundle][]. + +**Remember:** YCM is a plugin with a compiled component. If you **update** YCM +using Vundle and the ycm_support_libs library APIs have changed (happens +rarely), YCM will notify you to recompile it. You should then rerun the install +process. + +Install development tools and CMake: `sudo dnf install automake gcc gcc-c++ kernel-devel cmake` + +Make sure you have Python headers installed: `sudo dnf install python-devel`. + +Compiling YCM **with** semantic support for C-family languages: + + cd ~/.vim/bundle/YouCompleteMe + ./install.py --clang-completer + +Compiling YCM **without** semantic support for C-family languages: + + cd ~/.vim/bundle/YouCompleteMe + ./install.py + +If you want semantic C# support, you should add `--omnisharp-completer` to the +install script as well. If you want Go support, you should add +`--gocode-completer`. If you want semantic TypeScript support, install the +TypeScript SDK with `npm install -g typescript` (you'll need to install +[nodejs and npm][npm-install]). + +That's it. You're done. Refer to the _User Guide_ section on how to use YCM. +Don't forget that if you want the C-family semantic completion engine to work, +you will need to provide the compilation flags for your project to YCM. It's all +in the User Guide. + +YCM comes with sane defaults for its options, but you still may want to take a +look at what's available for configuration. There are a few interesting options +that are conservatively turned off by default that you may want to turn on. + ### Windows Installation Please refer to the full Installation Guide below; the following commands are