Skip to content

Commit c69ed9b

Browse files
authored
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.
1 parent 780f476 commit c69ed9b

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

docs/user/README.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,19 @@
11
The main interface to rust-analyzer is the
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
4-
install --package ra_lsp_server`. The binary is named `ra_lsp_server`, you
5-
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-
advantage of rust-analyzer. This repository contains support code for VS Code
8-
and Emacs.
9-
10-
Rust Analyzer needs sources of rust standard library to work, so you might need
11-
to execute
2+
[LSP](https://microsoft.github.io/language-server-protocol/)
3+
implementation. To install lsp server, clone the repository and
4+
then run `cargo xtask install --server`. This will produce a
5+
binary named `ra_lsp_server` which you should be able to use it
6+
with any LSP-compatible editor. We use custom extensions to LSP,
7+
so special client-side support is required to take full advantage
8+
of rust-analyzer. This repository contains support code for VS
9+
Code and Emacs.
10+
11+
```
12+
$ git clone git@github.com: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
1217

1318
```
1419
$ rustup component add rust-src

0 commit comments

Comments
 (0)