Skip to content

Commit c6eff1d

Browse files
bors[bot]fintelia
andauthored
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 <fintelia@gmail.com>
2 parents bd01f11 + 75be655 commit c6eff1d

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

docs/user/README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,19 @@
11
The main interface to rust-analyzer is the
22
[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
3+
install lsp server, clone the repository and then run `cargo xtask install
4+
--server` (which is shorthand for `cargo install --path
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
67
extensions to LSP, so special client-side support is required to take full
78
advantage of rust-analyzer. This repository contains support code for VS Code
89
and Emacs.
910

10-
Rust Analyzer needs sources of rust standard library to work, so you might need
11-
to execute
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)