From 3b6b949bb33c68f3a64e18757b27b870d1cfef8e Mon Sep 17 00:00:00 2001 From: Ben Jackson Date: Sat, 5 Mar 2016 16:20:19 +0000 Subject: [PATCH] Update README to include --all flag --- README.md | 39 ++++++++++++++++++++------------------- doc/youcompleteme.txt | 43 ++++++++++++++++++++++--------------------- 2 files changed, 42 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index 25426190..1e36e511 100644 --- a/README.md +++ b/README.md @@ -184,12 +184,12 @@ The following additional language support options are available: - Rust support: install [rustc and cargo][rust-install] and add `--racer-completer` to `./install.py` -For example, to install with all language features, ensure npm, go, mono, rust, -and typescript API are installed and in your PATH, then: +To simply compile with everything enabled, there's a `--all` flag. So, to +install with all language features, ensure `npm`, `go`, `mono`, `rust`, +and `typescript` API are installed and in your `PATH`, then simply run: cd ~/.vim/bundle/YouCompleteMe - ./install.py --clang-completer --omnisharp-completer --gocode-completer \ - --tern-completer --racer-completer + ./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, @@ -242,12 +242,12 @@ The following additional language support options are available: - Rust support: install [rustc and cargo][rust-install] and add `--racer-completer` to `./install.py` -For example, to install with all language features, ensure npm, go, mono, rust, -and typescript API are installed and in your PATH, then: +To simply compile with everything enabled, there's a `--all` flag. So, to +install with all language features, ensure `npm`, `go`, `mono`, `rust`, +and `typescript` API are installed and in your `PATH`, then simply run: cd ~/.vim/bundle/YouCompleteMe - ./install.py --clang-completer --omnisharp-completer --gocode-completer \ - --tern-completer --racer-completer + ./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, @@ -300,12 +300,12 @@ The following additional language support options are available: - Rust support: install [rustc and cargo][rust-install] and add `--racer-completer` to `./install.py` -For example, to install with all language features, ensure npm, go, mono, rust, -and typescript API are installed and in your PATH, then: +To simply compile with everything enabled, there's a `--all` flag. So, to +install with all language features, ensure `npm`, `go`, `mono`, `rust`, +and `typescript` API are installed and in your `PATH`, then simply run: cd ~/.vim/bundle/YouCompleteMe - ./install.py --clang-completer --omnisharp-completer --gocode-completer \ - --tern-completer --racer-completer + ./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, @@ -372,11 +372,12 @@ The following additional language support options are available: - Rust support: install [rustc and cargo][rust-install] and add `--racer-completer` to `install.py`. -For example, to install with all language features, ensure npm, go, mono, rust, -and typescript API are installed and in your `%PATH%`, then: +To simply compile with everything enabled, there's a `--all` flag. So, to +install with all language features, ensure `npm`, `go`, `mono`, `rust`, +and `typescript` API are installed and in your `%PATH%`, then simply run: cd %USERPROFILE%/vimfiles/bundle/YouCompleteMe - python install.py --clang-completer --omnisharp-completer --gocode-completer --tern-completer --racer-completer + python install.py --all You can specify the Microsoft Visual C++ (MSVC) version using the `--msvc` option. YCM officially supports MSVC 11 (Visual Studio 2012), 12 (2013), and 14 @@ -437,12 +438,12 @@ The following additional language support options are available: - Rust support: install [rustc and cargo][rust-install] and add `--racer-completer` to `./install.py` -For example, to install with all language features, ensure npm, go, mono, rust, -and typescript API are installed and in your PATH, then: +To simply compile with everything enabled, there's a `--all` flag. So, to +install with all language features, ensure `npm`, `go`, `mono`, `rust`, +and `typescript` API are installed and in your `PATH`, then simply run: cd ~/.vim/bundle/YouCompleteMe - ./install.py --clang-completer --omnisharp-completer --gocode-completer \ - --tern-completer --racer-completer + ./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, diff --git a/doc/youcompleteme.txt b/doc/youcompleteme.txt index 2a31d177..c136ec4b 100644 --- a/doc/youcompleteme.txt +++ b/doc/youcompleteme.txt @@ -170,8 +170,8 @@ Image: Build Status [1] Image: Build status [3] - Installation - Mac OS X - - Ubuntu - - Fedora + - Ubuntu Linux x64 + - Fedora Linux x64 - Windows - FreeBSD/OpenBSD - Full Installation Guide @@ -370,12 +370,12 @@ The following additional language support options are available: - Rust support: install rustc and cargo [23] and add '--racer-completer' to './install.py' -For example, to install with all language features, ensure npm, go, mono, rust, -and typescript API are installed and in your PATH, then: +To simply compile with everything enabled, there's a '--all' flag. So, to +install with all language features, ensure 'npm', 'go', 'mono', 'rust', and +'typescript' API are installed and in your 'PATH', then simply run: > cd ~/.vim/bundle/YouCompleteMe - ./install.py --clang-completer --omnisharp-completer --gocode-completer \ - --tern-completer --racer-completer + ./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, @@ -434,12 +434,12 @@ The following additional language support options are available: - Rust support: install rustc and cargo [23] and add '--racer-completer' to './install.py' -For example, to install with all language features, ensure npm, go, mono, rust, -and typescript API are installed and in your PATH, then: +To simply compile with everything enabled, there's a '--all' flag. So, to +install with all language features, ensure 'npm', 'go', 'mono', 'rust', and +'typescript' API are installed and in your 'PATH', then simply run: > cd ~/.vim/bundle/YouCompleteMe - ./install.py --clang-completer --omnisharp-completer --gocode-completer \ - --tern-completer --racer-completer + ./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, @@ -498,12 +498,12 @@ The following additional language support options are available: - Rust support: install rustc and cargo [23] and add '--racer-completer' to './install.py' -For example, to install with all language features, ensure npm, go, mono, rust, -and typescript API are installed and in your PATH, then: +To simply compile with everything enabled, there's a '--all' flag. So, to +install with all language features, ensure 'npm', 'go', 'mono', 'rust', and +'typescript' API are installed and in your 'PATH', then simply run: > cd ~/.vim/bundle/YouCompleteMe - ./install.py --clang-completer --omnisharp-completer --gocode-completer \ - --tern-completer --racer-completer + ./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, @@ -576,11 +576,12 @@ The following additional language support options are available: - Rust support: install rustc and cargo [23] and add '--racer-completer' to 'install.py'. -For example, to install with all language features, ensure npm, go, mono, rust, -and typescript API are installed and in your '%PATH%', then: +To simply compile with everything enabled, there's a '--all' flag. So, to +install with all language features, ensure 'npm', 'go', 'mono', 'rust', and +'typescript' API are installed and in your '%PATH%', then simply run: > cd %USERPROFILE%/vimfiles/bundle/YouCompleteMe - python install.py --clang-completer --omnisharp-completer --gocode-completer --tern-completer --racer-completer + python install.py --all < You can specify the Microsoft Visual C++ (MSVC) version using the '--msvc' option. YCM officially supports MSVC 11 (Visual Studio 2012), 12 (2013), and 14 @@ -646,12 +647,12 @@ The following additional language support options are available: - Rust support: install rustc and cargo [23] and add '--racer-completer' to './install.py' -For example, to install with all language features, ensure npm, go, mono, rust, -and typescript API are installed and in your PATH, then: +To simply compile with everything enabled, there's a '--all' flag. So, to +install with all language features, ensure 'npm', 'go', 'mono', 'rust', and +'typescript' API are installed and in your 'PATH', then simply run: > cd ~/.vim/bundle/YouCompleteMe - ./install.py --clang-completer --omnisharp-completer --gocode-completer \ - --tern-completer --racer-completer + ./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,