|
@@ -23,10 +23,7 @@ Contents ~
|
|
|
4. Windows |youcompleteme-windows|
|
|
|
1. Quick start, installing all completers
|
|
|
2. Explanation for the quick start
|
|
|
- 5. FreeBSD/OpenBSD |youcompleteme-freebsd-openbsd|
|
|
|
- 1. Quick start, installing all completers
|
|
|
- 2. Explanation for the quick start
|
|
|
- 6. Full Installation Guide |youcompleteme-full-installation-guide|
|
|
|
+ 5. 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++, CUDA) |youcompleteme-c-family-languages|
|
|
@@ -254,7 +251,6 @@ Contents ~
|
|
|
- macOS
|
|
|
- Linux 64-bit
|
|
|
- Windows
|
|
|
- - FreeBSD/OpenBSD
|
|
|
- Full Installation Guide
|
|
|
|
|
|
- Quick Feature Summary
|
|
@@ -850,94 +846,6 @@ 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-freebsd-openbsd*
|
|
|
-FreeBSD/OpenBSD ~
|
|
|
-
|
|
|
--------------------------------------------------------------------------------
|
|
|
-Quick start, installing all completers ~
|
|
|
-
|
|
|
-- Install YCM plugin via Vundle [26]
|
|
|
-- Install CMake
|
|
|
->
|
|
|
- pkg install cmake
|
|
|
-<
|
|
|
-- Install xbuild, go, node and npm
|
|
|
-- Compile YCM
|
|
|
->
|
|
|
- cd ~/.vim/bundle/YouCompleteMe
|
|
|
- python3 install.py --all
|
|
|
-<
|
|
|
-- For plugging an arbitrary LSP server, check the relevant section
|
|
|
-
|
|
|
--------------------------------------------------------------------------------
|
|
|
-Explanation for the quick start ~
|
|
|
-
|
|
|
-These instructions (using 'install.py') are the quickest way to install
|
|
|
-YouCompleteMe, however they may not work for everyone. If the following
|
|
|
-instructions don't work for you, check out the full installation guide.
|
|
|
-
|
|
|
-**NOTE:** OpenBSD / FreeBSD are not officially supported platforms by YCM.
|
|
|
-
|
|
|
-Make sure you have a supported Vim version with Python 3 support, and a
|
|
|
-supported compiler and CMake, perhaps:
|
|
|
->
|
|
|
- pkg install cmake
|
|
|
-<
|
|
|
-Install YouCompleteMe with Vundle [26].
|
|
|
-
|
|
|
-**Remember:** YCM is a plugin with a compiled component. If you **update** YCM
|
|
|
-using Vundle and the 'ycm_core' library APIs have changed (happens rarely), YCM
|
|
|
-will notify you to recompile it. You should then rerun the install process.
|
|
|
-
|
|
|
-Compiling YCM **with** semantic support for C-family languages through
|
|
|
-**clangd**:
|
|
|
->
|
|
|
- cd ~/.vim/bundle/YouCompleteMe
|
|
|
- ./install.py --clangd-completer
|
|
|
-<
|
|
|
-Compiling YCM **without** semantic support for C-family languages:
|
|
|
->
|
|
|
- cd ~/.vim/bundle/YouCompleteMe
|
|
|
- ./install.py
|
|
|
-<
|
|
|
-If the 'python' executable is not present, or the default 'python' is not the
|
|
|
-one that should be compiled against, specify the python interpreter explicitly:
|
|
|
->
|
|
|
- python3 install.py --clangd-completer
|
|
|
-<
|
|
|
-The following additional language support options are available:
|
|
|
-
|
|
|
-- C# support: install Mono and add '--cs-completer' when calling
|
|
|
- './install.py'.
|
|
|
-
|
|
|
-- Go support: install Go [31] and add '--go-completer' when calling
|
|
|
- './install.py'.
|
|
|
-
|
|
|
-- JavaScript and TypeScript support: install Node.js and npm [32] and add
|
|
|
- '--ts-completer' when calling 'install.py'.
|
|
|
-
|
|
|
-- Rust support: add '--rust-completer' when calling './install.py'.
|
|
|
-
|
|
|
-- Java support: install JDK 17 [33] and add '--java-completer' when calling
|
|
|
- './install.py'.
|
|
|
-
|
|
|
-To simply compile with everything enabled, there's a '--all' flag. So, to
|
|
|
-install with all language features, ensure 'xbuild', 'go', 'node' and 'npm'
|
|
|
-tools are installed and in your 'PATH', then simply run:
|
|
|
->
|
|
|
- cd ~/.vim/bundle/YouCompleteMe
|
|
|
- ./install.py --all
|
|
|
-<
|
|
|
-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-full-installation-guide*
|
|
|
Full Installation Guide ~
|
|
@@ -1399,7 +1307,7 @@ On supported architectures, the 'install.py' script will download a suitable
|
|
|
clangd ('--clangd-completer') or libclang ('--clang-completer') for you.
|
|
|
Supported architectures are:
|
|
|
|
|
|
-- Linux glibc >= 2.27 (Intel, armv7-a, aarch64) - built on ubuntu 18.04
|
|
|
+- Linux glibc >= 2.31 (Intel, armv7-a, aarch64) - built on ubuntu 20.04
|
|
|
- MacOS >=10.15 (Intel, arm64)
|
|
|
- For Intel, compatibility per clang.llvm.org downloads
|
|
|
- For arm64, macOS 10.15+
|
|
@@ -1423,7 +1331,7 @@ build or acquire 'libclang' for yourself and specify it when building, as:
|
|
|
$ EXTRA_CMAKE_ARGS='-DPATH_TO_LLVM_ROOT=/path/to/your/llvm' ./install.py --clang-completer --system-libclang
|
|
|
<
|
|
|
Please note that if using custom 'clangd' or 'libclang' it _must_ match the
|
|
|
-version that YCM requires. Currently YCM requires **_clang 15.0.1_**.
|
|
|
+version that YCM requires. Currently YCM requires **_clang 16.0.1_**.
|
|
|
|
|
|
-------------------------------------------------------------------------------
|
|
|
*youcompleteme-compile-flags*
|