aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/user/README.md25
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 @@
1The main interface to rust-analyzer is the 1The 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/)
3install lsp server, use `cargo xtask install --server`, which is a shorthand for `cargo 3implementation. To install lsp server, clone the repository and
4install --package ra_lsp_server`. The binary is named `ra_lsp_server`, you 4then run `cargo xtask install --server`. This will produce a
5should be able to use it with any LSP-compatible editor. We use custom 5binary named `ra_lsp_server` which you should be able to use it
6extensions to LSP, so special client-side support is required to take full 6with any LSP-compatible editor. We use custom extensions to LSP,
7advantage of rust-analyzer. This repository contains support code for VS Code 7so special client-side support is required to take full advantage
8and Emacs. 8of rust-analyzer. This repository contains support code for VS
9 9Code and Emacs.
10Rust Analyzer needs sources of rust standard library to work, so you might need 10
11to execute 11```
12$ git clone [email protected]:rust-analyzer/rust-analyzer && cd rust-analyzer
13$ cargo xtask install --server
14```
15Rust Analyzer needs sources of rust standard library to work, so
16you might also need to execute
12 17
13``` 18```
14$ rustup component add rust-src 19$ rustup component add rust-src