diff options
author | bors[bot] <26634292+bors[bot]@users.noreply.github.com> | 2019-12-02 12:42:33 +0000 |
---|---|---|
committer | GitHub <[email protected]> | 2019-12-02 12:42:33 +0000 |
commit | c6eff1da12478104c86aa4e344c9fc99c18701af (patch) | |
tree | 5db14d153acf878db9c3f2078f22c2b92dbba970 /docs/user/README.md | |
parent | bd01f112e11c81cccc440602cb669a86f6d01df1 (diff) | |
parent | 75be6553fef0256bc57d438dac4b2f66473156f4 (diff) |
Merge #2457
2457: Clarify installation instructions r=matklad a=fintelia
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.
Co-authored-by: Jonathan Behrens <[email protected]>
Diffstat (limited to 'docs/user/README.md')
-rw-r--r-- | docs/user/README.md | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/docs/user/README.md b/docs/user/README.md index 913ecea18..adacead52 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/) implementation. To |
3 | install lsp server, use `cargo xtask install --server`, which is a shorthand for `cargo | 3 | install lsp server, clone the repository and then run `cargo xtask install |
4 | install --package ra_lsp_server`. The binary is named `ra_lsp_server`, you | 4 | --server` (which is shorthand for `cargo install --path |
5 | should be able to use it with any LSP-compatible editor. We use custom | 5 | ./crates/ra_lsp_server`). This will produce a binary named `ra_lsp_server` which |
6 | you should be able to use it with any LSP-compatible editor. We use custom | ||
6 | extensions to LSP, so special client-side support is required to take full | 7 | extensions to LSP, so special client-side support is required to take full |
7 | advantage of rust-analyzer. This repository contains support code for VS Code | 8 | advantage of rust-analyzer. This repository contains support code for VS Code |
8 | and Emacs. | 9 | and Emacs. |
9 | 10 | ||
10 | Rust Analyzer needs sources of rust standard library to work, so you might need | 11 | ``` |
11 | to execute | 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 |