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

Merge pull request #2065 from micbou/completer-parameter-readme

Browse Source 
[READY] Fix more confusing phrasing in README
This commit is contained in:
Val Markovic 2016-03-20 17:34:05 -07:00
commit 21a0019279
2 changed files with 49 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -175,14 +175,15 @@ Compiling YCM **without** semantic support for C-family languages:
The following additional language support options are available: The following additional language support options are available:
- C# support: add `--omnisharp-completer` to `./install.py` - C# support: add `--omnisharp-completer` when calling `./install.py`.
- Go support: ensure go is installed and add `--gocode-completer` - Go support: ensure go is installed and add `--gocode-completer` when calling
`./install.py`.
- TypeScript support: install [nodejs and npm][npm-install] then install the - TypeScript support: install [nodejs and npm][npm-install] then install the
TypeScript SDK with `npm install -g typescript`. TypeScript SDK with `npm install -g typescript`.
- JavaScript support: install [nodejs and npm][npm-install] and add - JavaScript support: install [nodejs and npm][npm-install] and add
`--tern-completer` when calling `./install.py` `--tern-completer` when calling `./install.py`.
- Rust support: install [rustc and cargo][rust-install] and add - Rust support: install [rustc and cargo][rust-install] and add
`--racer-completer` when calling `./install.py` `--racer-completer` when calling `./install.py`.
To simply compile with everything enabled, there's a `--all` flag. So, to To simply compile with everything enabled, there's a `--all` flag. So, to
install with all language features, ensure `npm`, `go`, `mono`, `rust`, install with all language features, ensure `npm`, `go`, `mono`, `rust`,
@ -234,14 +235,15 @@ Compiling YCM **without** semantic support for C-family languages:
The following additional language support options are available: The following additional language support options are available:
- C# support: add `--omnisharp-completer` to `./install.py` - C# support: add `--omnisharp-completer` when calling `./install.py`.
- Go support: ensure go is installed and add `--gocode-completer` - Go support: ensure go is installed and add `--gocode-completer` when calling
`./install.py`.
- TypeScript support: install [nodejs and npm][npm-install] then install the - TypeScript support: install [nodejs and npm][npm-install] then install the
TypeScript SDK with `npm install -g typescript`. TypeScript SDK with `npm install -g typescript`.
- JavaScript support: install [nodejs and npm][npm-install] and add - JavaScript support: install [nodejs and npm][npm-install] and add
`--tern-completer` when calling `./install.py` `--tern-completer` when calling `./install.py`.
- Rust support: install [rustc and cargo][rust-install] and add - Rust support: install [rustc and cargo][rust-install] and add
`--racer-completer` when calling `./install.py` `--racer-completer` when calling `./install.py`.
To simply compile with everything enabled, there's a `--all` flag. So, to To simply compile with everything enabled, there's a `--all` flag. So, to
install with all language features, ensure `npm`, `go`, `mono`, `rust`, install with all language features, ensure `npm`, `go`, `mono`, `rust`,
@ -293,14 +295,15 @@ Compiling YCM **without** semantic support for C-family languages:
The following additional language support options are available: The following additional language support options are available:
- C# support: add `--omnisharp-completer` to `./install.py` - C# support: add `--omnisharp-completer` when calling `./install.py`.
- Go support: ensure go is installed and add `--gocode-completer` - Go support: ensure go is installed and add `--gocode-completer` when calling
`./install.py`.
- TypeScript support: install [nodejs and npm][npm-install] then install the - TypeScript support: install [nodejs and npm][npm-install] then install the
TypeScript SDK with `npm install -g typescript`. TypeScript SDK with `npm install -g typescript`.
- JavaScript support: install [nodejs and npm][npm-install] and add - JavaScript support: install [nodejs and npm][npm-install] and add
`--tern-completer` when calling `./install.py` `--tern-completer` when calling `./install.py`.
- Rust support: install [rustc and cargo][rust-install] and add - Rust support: install [rustc and cargo][rust-install] and add
`--racer-completer` when calling `./install.py` `--racer-completer` when calling `./install.py`.
To simply compile with everything enabled, there's a `--all` flag. So, to To simply compile with everything enabled, there's a `--all` flag. So, to
install with all language features, ensure `npm`, `go`, `mono`, `rust`, install with all language features, ensure `npm`, `go`, `mono`, `rust`,
@ -364,9 +367,10 @@ Compiling YCM **without** semantic support for C-family languages:
The following additional language support options are available: The following additional language support options are available:
- C# support: add `--omnisharp-completer` to `install.py`. - C# support: add `--omnisharp-completer` when calling `install.py`.
Be sure that [the build utility `msbuild` is in your PATH][add-msbuild-to-path]. Be sure that [the build utility `msbuild` is in your PATH][add-msbuild-to-path].
- Go support: ensure go is installed and add `--gocode-completer`. - Go support: ensure go is installed and add `--gocode-completer` when calling
`install.py`.
- TypeScript support: install [nodejs and npm][npm-install] then install the - TypeScript support: install [nodejs and npm][npm-install] then install the
TypeScript SDK with `npm install -g typescript`. TypeScript SDK with `npm install -g typescript`.
- JavaScript support: install [nodejs and npm][npm-install] and add - JavaScript support: install [nodejs and npm][npm-install] and add
@ -431,14 +435,15 @@ Compiling YCM **without** semantic support for C-family languages:
The following additional language support options are available: The following additional language support options are available:
- C# support: add `--omnisharp-completer` to `./install.py` - C# support: add `--omnisharp-completer` when calling `./install.py`.
- Go support: ensure go is installed and add `--gocode-completer` - Go support: ensure go is installed and add `--gocode-completer` when calling
`./install.py`.
- TypeScript support: install [nodejs and npm][npm-install] then install the - TypeScript support: install [nodejs and npm][npm-install] then install the
TypeScript SDK with `npm install -g typescript`. TypeScript SDK with `npm install -g typescript`.
- JavaScript support: install [nodejs and npm][npm-install] and add - JavaScript support: install [nodejs and npm][npm-install] and add
`--tern-completer` when calling `./install.py` `--tern-completer` when calling `./install.py`.
- Rust support: install [rustc and cargo][rust-install] and add - Rust support: install [rustc and cargo][rust-install] and add
`--racer-completer` when calling `./install.py` `--racer-completer` when calling `./install.py`.
To simply compile with everything enabled, there's a `--all` flag. So, to To simply compile with everything enabled, there's a `--all` flag. So, to
install with all language features, ensure `npm`, `go`, `mono`, `rust`, install with all language features, ensure `npm`, `go`, `mono`, `rust`,

47
doc/youcompleteme.txt
View File

@ -358,18 +358,19 @@ Compiling YCM **without** semantic support for C-family languages:
< <
The following additional language support options are available: The following additional language support options are available:
- C# support: add '--omnisharp-completer' to './install.py' - C# support: add '--omnisharp-completer' when calling './install.py'.
- Go support: ensure go is installed and add '--gocode-completer' - Go support: ensure go is installed and add '--gocode-completer' when
calling './install.py'.
- TypeScript support: install nodejs and npm [22] then install the TypeScript - TypeScript support: install nodejs and npm [22] then install the TypeScript
SDK with 'npm install -g typescript'. SDK with 'npm install -g typescript'.
- JavaScript support: install nodejs and npm [22] and add '--tern-completer' - JavaScript support: install nodejs and npm [22] and add '--tern-completer'
when calling './install.py' when calling './install.py'.
- Rust support: install rustc and cargo [23] and add '--racer-completer' when - Rust support: install rustc and cargo [23] and add '--racer-completer' when
calling './install.py' calling './install.py'.
To simply compile with everything enabled, there's a '--all' flag. So, to To simply compile with everything enabled, there's a '--all' flag. So, to
install with all language features, ensure 'npm', 'go', 'mono', 'rust', and install with all language features, ensure 'npm', 'go', 'mono', 'rust', and
@ -423,18 +424,19 @@ Compiling YCM **without** semantic support for C-family languages:
< <
The following additional language support options are available: The following additional language support options are available:
- C# support: add '--omnisharp-completer' to './install.py' - C# support: add '--omnisharp-completer' when calling './install.py'.
- Go support: ensure go is installed and add '--gocode-completer' - Go support: ensure go is installed and add '--gocode-completer' when
calling './install.py'.
- TypeScript support: install nodejs and npm [22] then install the TypeScript - TypeScript support: install nodejs and npm [22] then install the TypeScript
SDK with 'npm install -g typescript'. SDK with 'npm install -g typescript'.
- JavaScript support: install nodejs and npm [22] and add '--tern-completer' - JavaScript support: install nodejs and npm [22] and add '--tern-completer'
when calling './install.py' when calling './install.py'.
- Rust support: install rustc and cargo [23] and add '--racer-completer' when - Rust support: install rustc and cargo [23] and add '--racer-completer' when
calling './install.py' calling './install.py'.
To simply compile with everything enabled, there's a '--all' flag. So, to To simply compile with everything enabled, there's a '--all' flag. So, to
install with all language features, ensure 'npm', 'go', 'mono', 'rust', and install with all language features, ensure 'npm', 'go', 'mono', 'rust', and
@ -488,18 +490,19 @@ Compiling YCM **without** semantic support for C-family languages:
< <
The following additional language support options are available: The following additional language support options are available:
- C# support: add '--omnisharp-completer' to './install.py' - C# support: add '--omnisharp-completer' when calling './install.py'.
- Go support: ensure go is installed and add '--gocode-completer' - Go support: ensure go is installed and add '--gocode-completer' when
calling './install.py'.
- TypeScript support: install nodejs and npm [22] then install the TypeScript - TypeScript support: install nodejs and npm [22] then install the TypeScript
SDK with 'npm install -g typescript'. SDK with 'npm install -g typescript'.
- JavaScript support: install nodejs and npm [22] and add '--tern-completer' - JavaScript support: install nodejs and npm [22] and add '--tern-completer'
when calling './install.py' when calling './install.py'.
- Rust support: install rustc and cargo [23] and add '--racer-completer' when - Rust support: install rustc and cargo [23] and add '--racer-completer' when
calling './install.py' calling './install.py'.
To simply compile with everything enabled, there's a '--all' flag. So, to To simply compile with everything enabled, there's a '--all' flag. So, to
install with all language features, ensure 'npm', 'go', 'mono', 'rust', and install with all language features, ensure 'npm', 'go', 'mono', 'rust', and
@ -565,10 +568,11 @@ Compiling YCM **without** semantic support for C-family languages:
< <
The following additional language support options are available: The following additional language support options are available:
- C# support: add '--omnisharp-completer' to 'install.py'. Be sure that the - C# support: add '--omnisharp-completer' when calling 'install.py'. Be sure
build utility 'msbuild' is in your PATH [29]. that the build utility 'msbuild' is in your PATH [29].
- Go support: ensure go is installed and add '--gocode-completer'. - Go support: ensure go is installed and add '--gocode-completer' when
calling 'install.py'.
- TypeScript support: install nodejs and npm [22] then install the TypeScript - TypeScript support: install nodejs and npm [22] then install the TypeScript
SDK with 'npm install -g typescript'. SDK with 'npm install -g typescript'.
@ -637,18 +641,19 @@ Compiling YCM **without** semantic support for C-family languages:
< <
The following additional language support options are available: The following additional language support options are available:
- C# support: add '--omnisharp-completer' to './install.py' - C# support: add '--omnisharp-completer' when calling './install.py'.
- Go support: ensure go is installed and add '--gocode-completer' - Go support: ensure go is installed and add '--gocode-completer' when
calling './install.py'.
- TypeScript support: install nodejs and npm [22] then install the TypeScript - TypeScript support: install nodejs and npm [22] then install the TypeScript
SDK with 'npm install -g typescript'. SDK with 'npm install -g typescript'.
- JavaScript support: install nodejs and npm [22] and add '--tern-completer' - JavaScript support: install nodejs and npm [22] and add '--tern-completer'
when calling './install.py' when calling './install.py'.
- Rust support: install rustc and cargo [23] and add '--racer-completer' when - Rust support: install rustc and cargo [23] and add '--racer-completer' when
calling './install.py' calling './install.py'.
To simply compile with everything enabled, there's a '--all' flag. So, to To simply compile with everything enabled, there's a '--all' flag. So, to
install with all language features, ensure 'npm', 'go', 'mono', 'rust', and install with all language features, ensure 'npm', 'go', 'mono', 'rust', and
@ -846,8 +851,8 @@ will notify you to recompile it. You should then rerun the install process.
-g typescript' after successfully installing nodejs and npm [22]. -g typescript' after successfully installing nodejs and npm [22].
9. JavaScript support: Install nodejs and npm [22]. Then navigate to 9. JavaScript support: Install nodejs and npm [22]. Then navigate to
'YouCompleteMe/third_party/ycmd/third_party/tern' and run 'npm install 'YouCompleteMe/third_party/ycmd/third_party/tern_runtime' and run 'npm
--production' install --production'
10. Rust support: Install rustc and cargo [23]. Navigate to 10. Rust support: Install rustc and cargo [23]. Navigate to
'YouCompleteMe/third_party/ycmd/third_party/racerd' and run 'cargo 'YouCompleteMe/third_party/ycmd/third_party/racerd' and run 'cargo