Browse Source

Minor changes to README

Add capital letters to languages when appropriate.
Be more specific with the tools needed in the PATH when using the
--all option.
micbou 8 years ago
parent
commit
4bbda99cc0
1 changed files with 43 additions and 41 deletions
  1. 43 41
      README.md

+ 43 - 41
README.md

@@ -180,16 +180,17 @@ The following additional language support options are available:
   `./install.py`.
 - Go support: install [Go][go-install] and add `--gocode-completer` when calling
   `./install.py`.
-- TypeScript support: install [nodejs and npm][npm-install] then install the
+- TypeScript support: install [Node.js and npm][npm-install] then install the
   TypeScript SDK with `npm install -g typescript`.
-- JavaScript support: install [nodejs and npm][npm-install] and add
+- JavaScript support: install [Node.js and npm][npm-install] and add
   `--tern-completer` when calling `./install.py`.
-- Rust support: install [rustc and cargo][rust-install] and add
+- Rust support: install [Rust][rust-install] and add
   `--racer-completer` when calling `./install.py`.
 
 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:
+install with all language features, ensure `xbuild`, `go`, `tsserver`, `node`,
+`npm`, `rustc`, and `cargo` tools are installed and in your `PATH`, then
+simply run:
 
     cd ~/.vim/bundle/YouCompleteMe
     ./install.py --all
@@ -239,18 +240,19 @@ The following additional language support options are available:
 
 - C# support: install [Mono][mono-install-ubuntu] and add `--omnisharp-completer`
   when calling `./install.py`.
-- Go support: install [go][go-install] and add `--gocode-completer` when calling
+- Go support: install [Go][go-install] and add `--gocode-completer` when calling
   `./install.py`.
-- TypeScript support: install [nodejs and npm][npm-install] then install the
+- TypeScript support: install [Node.js and npm][npm-install] then install the
   TypeScript SDK with `npm install -g typescript`.
-- JavaScript support: install [nodejs and npm][npm-install] and add
+- JavaScript support: install [Node.js and npm][npm-install] and add
   `--tern-completer` when calling `./install.py`.
-- Rust support: install [rustc and cargo][rust-install] and add
-  `--racer-completer` when calling `./install.py`.
+- Rust support: install [Rust][rust-install] and add `--racer-completer` when
+  calling `./install.py`.
 
 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:
+install with all language features, ensure `xbuild`, `go`, `tsserver`, `node`,
+`npm`, `rustc`, and `cargo` tools are installed and in your `PATH`, then
+simply run:
 
     cd ~/.vim/bundle/YouCompleteMe
     ./install.py --all
@@ -300,18 +302,19 @@ The following additional language support options are available:
 
 - C# support: install [Mono][mono-install-fedora] and add `--omnisharp-completer`
   when calling `./install.py`.
-- Go support: install [go][go-install] and add `--gocode-completer` when calling
+- Go support: install [Go][go-install] and add `--gocode-completer` when calling
   `./install.py`.
-- TypeScript support: install [nodejs and npm][npm-install] then install the
+- TypeScript support: install [Node.js and npm][npm-install] then install the
   TypeScript SDK with `npm install -g typescript`.
-- JavaScript support: install [nodejs and npm][npm-install] and add
+- JavaScript support: install [Node.js and npm][npm-install] and add
   `--tern-completer` when calling `./install.py`.
-- Rust support: install [rustc and cargo][rust-install] and add
-  `--racer-completer` when calling `./install.py`.
+- Rust support: install [Rust][rust-install] and add `--racer-completer` when
+  calling `./install.py`.
 
 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:
+install with all language features, ensure `xbuild`, `go`, `tsserver`, `node`,
+`npm`, `rustc`, and `cargo` tools are installed and in your `PATH`, then
+simply run:
 
     cd ~/.vim/bundle/YouCompleteMe
     ./install.py --all
@@ -375,18 +378,18 @@ The following additional language support options are available:
 
 - C# support: add `--omnisharp-completer` when calling `install.py`.
   Be sure that [the build utility `msbuild` is in your PATH][add-msbuild-to-path].
-- Go support: install [go][go-install] and add `--gocode-completer` when calling
+- Go support: install [Go][go-install] and add `--gocode-completer` when calling
   `install.py`.
-- TypeScript support: install [nodejs and npm][npm-install] then install the
+- TypeScript support: install [Node.js and npm][npm-install] then install the
   TypeScript SDK with `npm install -g typescript`.
-- JavaScript support: install [nodejs and npm][npm-install] and add
+- JavaScript support: install [Node.js and npm][npm-install] and add
   `--tern-completer` when calling `install.py`.
-- Rust support: install [rustc and cargo][rust-install] and add
-  `--racer-completer` when calling `install.py`.
+- Rust support: install [Rust][rust-install] and add `--racer-completer` when
+  calling `install.py`.
 
 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:
+install with all language features, ensure `msbuild`, `go`, `tsserver`, `node`,
+`npm`, and `cargo` tools are installed and in your `PATH`, then simply run:
 
     cd %USERPROFILE%/vimfiles/bundle/YouCompleteMe
     python install.py --all
@@ -443,18 +446,18 @@ The following additional language support options are available:
 
 - C# support: install Mono and add `--omnisharp-completer` when calling
   `./install.py`.
-- Go support: install [go][go-install] and add `--gocode-completer` when calling
+- Go support: install [Go][go-install] and add `--gocode-completer` when calling
   `./install.py`.
-- TypeScript support: install [nodejs and npm][npm-install] then install the
+- TypeScript support: install [Node.js and npm][npm-install] then install the
   TypeScript SDK with `npm install -g typescript`.
-- JavaScript support: install [nodejs and npm][npm-install] and add
+- JavaScript support: install [Node.js and npm][npm-install] and add
   `--tern-completer` when calling `./install.py`.
-- Rust support: install [rustc and cargo][rust-install] and add
-  `--racer-completer` when calling `./install.py`.
+- Rust support: install [Rust][rust-install] and add `--racer-completer` when
+  calling `./install.py`.
 
 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:
+install with all language features, ensure `xbuild`, `go`, `tsserver`, `node`,
+`npm`, and `cargo` tools are installed and in your `PATH`, then simply run:
 
     cd ~/.vim/bundle/YouCompleteMe
     ./install.py --all
@@ -632,24 +635,23 @@ process.
 
 5. Set up support for additional languages, as desired:
 
-  - C# support: Install [Mono on non-Windows platforms][mono-install]. Navigate
+  - C# support: install [Mono on non-Windows platforms][mono-install]. Navigate
     to `YouCompleteMe/third_party/ycmd/third_party/OmniSharpServer` and run
     `msbuild` (Windows) or `xbuild` (other platforms, using Mono) depending on
     your platform. On Windows, be sure that [the build utility `msbuild` is in
     your PATH][add-msbuild-to-path].
 
-  - Go support: If go is not installed on your system, [install it][go-install]
-    and add it to your path. Navigate to `YouCompleteMe/third_party/ycmd/third_party/gocode`
-    and run `go build`.
+  - Go support: install [Go][go-install] and add it to your path. Navigate to
+    `YouCompleteMe/third_party/ycmd/third_party/gocode` and run `go build`.
 
-  - TypeScript support: As with the quick installation, simply `npm install -g
-    typescript` after successfully installing [nodejs and npm][npm-install].
+  - TypeScript support: as with the quick installation, simply `npm install -g
+    typescript` after successfully installing [Node.js and npm][npm-install].
 
-  - JavaScript support: Install [nodejs and npm][npm-install]. Then navigate to
+  - JavaScript support: install [Node.js and npm][npm-install]. Then navigate to
     `YouCompleteMe/third_party/ycmd/third_party/tern_runtime` and run `npm install
     --production`
 
-  - Rust support: Install [rustc and cargo][rust-install]. Navigate to
+  - Rust support: install [Rust][rust-install]. Navigate to
     `YouCompleteMe/third_party/ycmd/third_party/racerd` and run
     `cargo build --release`.