vim/YouCompleteMe
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge pull request #1457 from ekfriis/gocode-docs

Browse Source 
Update README for Gocode support in ycmd.
This commit is contained in:
Val Markovic 2015-04-15 12:10:27 -07:00
commit 038cc3b648
2 changed files with 14 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -16,8 +16,6 @@ YouCompleteMe: a code-completion engine for Vim
- [Completion string ranking](#completion-string-ranking) - [Completion string ranking](#completion-string-ranking)
- [General semantic completion](#general-semantic-completion-engine-usage) - [General semantic completion](#general-semantic-completion-engine-usage)
- [C-family semantic completion](#c-family-semantic-completion-engine-usage) - [C-family semantic completion](#c-family-semantic-completion-engine-usage)
- [Python semantic completion](#python-semantic-completion)
- [C# semantic completion](#c-semantic-completion)
- [Semantic completion for other languages](#semantic-completion-for-other-languages) - [Semantic completion for other languages](#semantic-completion-for-other-languages)
- [Writing new semantic completers](#writing-new-semantic-completers) - [Writing new semantic completers](#writing-new-semantic-completers)
- [Diagnostic display](#diagnostic-display) - [Diagnostic display](#diagnostic-display)
@ -39,9 +37,10 @@ YouCompleteMe is a fast, as-you-type, fuzzy-search code completion engine for
works with every programming language, a semantic, [Clang][]-based engine that works with every programming language, a semantic, [Clang][]-based engine that
provides native semantic code completion for C/C++/Objective-C/Objective-C++ provides native semantic code completion for C/C++/Objective-C/Objective-C++
(from now on referred to as "the C-family languages"), a [Jedi][]-based (from now on referred to as "the C-family languages"), a [Jedi][]-based
completion engine for Python, an [OmniSharp][]-based completion engine for C# completion engine for Python, an [OmniSharp][]-based completion engine for C#,
and an omnifunc-based completer that uses data from Vim's omnicomplete system to a [Gocode][]-based completion engine for Go, and an omnifunc-based completer
provide semantic completions for many other languages (Ruby, PHP etc.). that uses data from Vim's omnicomplete system to provide semantic completions
for many other languages (Ruby, PHP etc.).
![YouCompleteMe GIF demo](http://i.imgur.com/0OP4ood.gif) ![YouCompleteMe GIF demo](http://i.imgur.com/0OP4ood.gif)
@ -147,7 +146,7 @@ Compiling YCM **without** semantic support for C-family languages:
./install.sh ./install.sh
If you want semantic C# support, you should add `--omnisharp-completer` to the If you want semantic C# support, you should add `--omnisharp-completer` to the
install script as well. install script as well. If you want Go support, you should add `--gocode-completer`.
That's it. You're done. Refer to the _User Guide_ section on how to use YCM. 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, Don't forget that if you want the C-family semantic completion engine to work,
@ -190,7 +189,7 @@ Compiling YCM **without** semantic support for C-family languages:
./install.sh ./install.sh
If you want semantic C# support, you should add `--omnisharp-completer` to the If you want semantic C# support, you should add `--omnisharp-completer` to the
install script as well. install script as well. If you want Go support, you should add `--gocode-completer`.
That's it. You're done. Refer to the _User Guide_ section on how to use YCM. 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, Don't forget that if you want the C-family semantic completion engine to work,
@ -243,7 +242,7 @@ Compiling YCM **without** semantic support for C-family languages:
./install.sh --system-boost ./install.sh --system-boost
If you want semantic C# support, you should add `--omnisharp-completer` to the If you want semantic C# support, you should add `--omnisharp-completer` to the
install script as well. install script as well. If you want Go support, you should add `--gocode-completer`.
That's it. You're done. Refer to the _User Guide_ section on how to use YCM. 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, Don't forget that if you want the C-family semantic completion engine to work,
@ -502,6 +501,11 @@ your file.
### Semantic completion for other languages ### Semantic completion for other languages
Python, C#, and Go are supported natively by YouCompleteMe using the [Jedi][],
[Omnisharp][], and [Gocode][] engines, respectively. Check the
[installation](#installation) section for instructions to enable these features
if desired.
YCM will use your `omnifunc` (see `:h omnifunc` in Vim) as a source for semantic YCM will use your `omnifunc` (see `:h omnifunc` in Vim) as a source for semantic
completions if it does not have a native semantic completion engine for your completions if it does not have a native semantic completion engine for your
file's filetype. Vim comes with okayish omnifuncs for various languages like file's filetype. Vim comes with okayish omnifuncs for various languages like
@ -1989,3 +1993,4 @@ This software is licensed under the [GPL v3 license][gpl].
[bear]: https://github.com/rizsotto/Bear [bear]: https://github.com/rizsotto/Bear
[Options]: https://github.com/Valloric/YouCompleteMe#options [Options]: https://github.com/Valloric/YouCompleteMe#options
[ygen]: https://github.com/rdnetto/YCM-Generator [ygen]: https://github.com/rdnetto/YCM-Generator
[Gocode]: https://github.com/nsf/gocode

2
third_party/ycmd vendored

@ -1 +1 @@
Subproject commit 8e228643ffcab2aa274777ca8b9b0c8183f0ef24 Subproject commit 7be4ab30a51225a936e402e50336b0b89bb9d697