浏览代码

Auto merge of #1742 - micbou:documentation, r=Valloric

Add an entry for Fedora installation in README.md

Following PR #1740. Update the Vim documentation.

Maybe we should remove the `super-quick` in the titles to make them shorter and be consistent with the others. I'll update the PR if you agree.

<!-- Reviewable:start -->
[<img src="https://reviewable.io/review_button.png" height=40 alt="Review on Reviewable"/>](https://reviewable.io/reviews/valloric/youcompleteme/1742)
<!-- Reviewable:end -->
Homu 9 年之前
父节点
当前提交
f20c69321d
共有 2 个文件被更改,包括 65 次插入14 次删除
  1. 6 5
      README.md
  2. 59 9
      doc/youcompleteme.txt

+ 6 - 5
README.md

@@ -6,8 +6,9 @@ YouCompleteMe: a code-completion engine for Vim
 
 - [Intro](#intro)
 - [Installation](#installation)
-    - [Mac OS X](#mac-os-x-super-quick-installation)
-    - [Ubuntu](#ubuntu-linux-x64-super-quick-installation)
+    - [Mac OS X](#mac-os-x-installation)
+    - [Ubuntu](#ubuntu-linux-x64-installation)
+    - [Fedora](#fedora-linux-x64-installation)
     - [Windows](#windows-installation)
     - [FreeBSD/OpenBSD](#freebsdopenbsd-installation)
     - [Full Installation Guide](#full-installation-guide)
@@ -108,7 +109,7 @@ and a completer that integrates with [UltiSnips][].
 Installation
 ------------
 
-### Mac OS X super-quick installation
+### Mac OS X 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.
@@ -164,7 +165,7 @@ 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.
 
-### Ubuntu Linux x64 super-quick installation
+### Ubuntu Linux x64 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.
@@ -210,7 +211,7 @@ 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
+### Fedora Linux x64 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.

+ 59 - 9
doc/youcompleteme.txt

@@ -6,11 +6,12 @@ Contents ~
  1. Introduction                                   |youcompleteme-introduction|
  2. Intro                                                 |youcompleteme-intro|
  3. Installation                                   |youcompleteme-installation|
-  1. Mac OS X super-quick installation |youcompleteme-mac-os-x-super-quick-installation|
-  2. Ubuntu Linux x64 super-quick installation |youcompleteme-ubuntu-linux-x64-super-quick-installation|
-  3. Windows Installation                  |youcompleteme-windows-installation|
-  4. FreeBSD/OpenBSD Installation  |youcompleteme-freebsd-openbsd-installation|
-  5. Full Installation Guide            |youcompleteme-full-installation-guide|
+  1. Mac OS X Installation                |youcompleteme-mac-os-x-installation|
+  2. Ubuntu Linux x64 Installation |youcompleteme-ubuntu-linux-x64-installation|
+  3. Fedora Linux x64 Installation |youcompleteme-fedora-linux-x64-installation|
+  4. Windows Installation                  |youcompleteme-windows-installation|
+  5. FreeBSD/OpenBSD Installation  |youcompleteme-freebsd-openbsd-installation|
+  6. Full Installation Guide            |youcompleteme-full-installation-guide|
  4. Quick Feature Summary                 |youcompleteme-quick-feature-summary|
   1. General (all languages)                            |youcompleteme-general|
   2. C-family languages (C, C++, Objective C, Objective C++) |youcompleteme-c-family-languages|
@@ -144,6 +145,7 @@ Image: Build Status [1] Image: Build status [3]
 
   - Mac OS X
   - Ubuntu
+  - Fedora
   - Windows
   - FreeBSD/OpenBSD
   - Full Installation Guide
@@ -259,8 +261,8 @@ and a completer that integrates with UltiSnips [13].
 Installation ~
 
 -------------------------------------------------------------------------------
-                              *youcompleteme-mac-os-x-super-quick-installation*
-Mac OS X super-quick installation ~
+                                          *youcompleteme-mac-os-x-installation*
+Mac OS X 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.
@@ -316,8 +318,8 @@ 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.
 
 -------------------------------------------------------------------------------
-                      *youcompleteme-ubuntu-linux-x64-super-quick-installation*
-Ubuntu Linux x64 super-quick installation ~
+                                  *youcompleteme-ubuntu-linux-x64-installation*
+Ubuntu Linux x64 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.
@@ -363,6 +365,54 @@ 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.
 
+-------------------------------------------------------------------------------
+                                  *youcompleteme-fedora-linux-x64-installation*
+Fedora Linux x64 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 [19] (don't worry, it's easy).
+
+Install YouCompleteMe with Vundle [15].
+
+**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 [18]).
+
+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.
+
 -------------------------------------------------------------------------------
                                            *youcompleteme-windows-installation*
 Windows Installation ~