diff options
| author | Jonathan Behrens <[email protected]> | 2019-12-01 02:20:54 +0000 |
|---|---|---|
| committer | GitHub <[email protected]> | 2019-12-01 02:20:54 +0000 |
| commit | c69ed9bd1f83e172def2678550ab4dd7c1b1dc1a (patch) | |
| tree | 14e0ce58d453d074f0d4f4366bce78d20865fe74 /docs | |
| parent | 780f476b4f438d473bc2e2299c2b8bf0a6fb9257 (diff) | |
Clarify installation instructions
In particular it is necessary to clone the repository before running the other commands. I also removed the `cargo install` side note because it didn't actually work (running the command just produces an error that --package isn't a recognized flag) and added a tldr code block with the list of commands to run.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/user/README.md | 25 |
1 files changed, 15 insertions, 10 deletions
diff --git a/docs/user/README.md b/docs/user/README.md index 913ecea18..35c40164b 100644 --- a/docs/user/README.md +++ b/docs/user/README.md | |||
| @@ -1,14 +1,19 @@ | |||
| 1 | The main interface to rust-analyzer is the | 1 | The main interface to rust-analyzer is the |
| 2 | [LSP](https://microsoft.github.io/language-server-protocol/) implementation. To | 2 | [LSP](https://microsoft.github.io/language-server-protocol/) |
| 3 | install lsp server, use `cargo xtask install --server`, which is a shorthand for `cargo | 3 | implementation. To install lsp server, clone the repository and |
| 4 | install --package ra_lsp_server`. The binary is named `ra_lsp_server`, you | 4 | then run `cargo xtask install --server`. This will produce a |
| 5 | should be able to use it with any LSP-compatible editor. We use custom | 5 | binary named `ra_lsp_server` which you should be able to use it |
| 6 | extensions to LSP, so special client-side support is required to take full | 6 | with any LSP-compatible editor. We use custom extensions to LSP, |
| 7 | advantage of rust-analyzer. This repository contains support code for VS Code | 7 | so special client-side support is required to take full advantage |
| 8 | and Emacs. | 8 | of rust-analyzer. This repository contains support code for VS |
| 9 | 9 | Code and Emacs. | |
| 10 | Rust Analyzer needs sources of rust standard library to work, so you might need | 10 | |
| 11 | to execute | 11 | ``` |
| 12 | $ git clone [email protected]:rust-analyzer/rust-analyzer && cd rust-analyzer | ||
| 13 | $ cargo xtask install --server | ||
| 14 | ``` | ||
| 15 | Rust Analyzer needs sources of rust standard library to work, so | ||
| 16 | you might also need to execute | ||
| 12 | 17 | ||
| 13 | ``` | 18 | ``` |
| 14 | $ rustup component add rust-src | 19 | $ rustup component add rust-src |