diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/user/readme.adoc | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/docs/user/readme.adoc b/docs/user/readme.adoc index b9ecc7055..867aae975 100644 --- a/docs/user/readme.adoc +++ b/docs/user/readme.adoc | |||
@@ -11,6 +11,9 @@ This manual focuses on a specific usage of the library -- the implementation of | |||
11 | https://microsoft.github.io/language-server-protocol/[Language Server Protocol]. | 11 | https://microsoft.github.io/language-server-protocol/[Language Server Protocol]. |
12 | LSP allows various code editors, like VS Code, Emacs or Vim, to implement semantic feature like completion or goto definition by talking to an external language server process. | 12 | LSP allows various code editors, like VS Code, Emacs or Vim, to implement semantic feature like completion or goto definition by talking to an external language server process. |
13 | 13 | ||
14 | To improve this document, send a pull request against | ||
15 | https://github.com/rust-analyzer/rust-analyzer/blob/master/docs/user/readme.adoc[this file]. | ||
16 | |||
14 | == Installation | 17 | == Installation |
15 | 18 | ||
16 | In theory, one should be able to just install the server binary and have it automatically work with any editor. | 19 | In theory, one should be able to just install the server binary and have it automatically work with any editor. |
@@ -44,7 +47,7 @@ Alternatively, both the server and the plugin can be installed from source: | |||
44 | 47 | ||
45 | [source] | 48 | [source] |
46 | ---- | 49 | ---- |
47 | $ git clone https://github.com/rust-analyzer/rust-analyzer.git && cs rust-analyzer | 50 | $ git clone https://github.com/rust-analyzer/rust-analyzer.git && cd rust-analyzer |
48 | $ cargo xtask install | 51 | $ cargo xtask install |
49 | ---- | 52 | ---- |
50 | 53 | ||