diff options
author | Aleksey Kladov <[email protected]> | 2020-03-05 16:26:47 +0000 |
---|---|---|
committer | Aleksey Kladov <[email protected]> | 2020-03-05 16:26:47 +0000 |
commit | c629ada8203c32fbdc313b6644bb934e0aff2f53 (patch) | |
tree | c251b0a5a07e23a78f551151626c5bfec5cf5282 | |
parent | fc4d0a7768c95ba50a224cab401b3a04501463d3 (diff) |
Link proper docs from readme
-rw-r--r-- | README.md | 30 |
1 files changed, 3 insertions, 27 deletions
@@ -14,33 +14,9 @@ Work on rust-analyzer is sponsored by | |||
14 | - [Mozilla](https://www.mozilla.org/en-US/) | 14 | - [Mozilla](https://www.mozilla.org/en-US/) |
15 | - [freiheit.com](https://www.freiheit.com) | 15 | - [freiheit.com](https://www.freiheit.com) |
16 | 16 | ||
17 | ## Language Server Quick Start | 17 | ## Quick Start |
18 | 18 | ||
19 | rust-analyzer is a work-in-progress, so you might encounter critical bugs. That | 19 | https://rust-analyzer.github.io/manual.html#installation |
20 | said, it is complete enough to provide a useful IDE experience and some people | ||
21 | use it as a daily driver. | ||
22 | |||
23 | To build rust-analyzer, you need: | ||
24 | |||
25 | * latest stable Rust for the language server itself | ||
26 | * latest stable npm and VS Code for VS Code extension | ||
27 | |||
28 | To quickly install the rust-analyzer language server and VS Code extension with | ||
29 | standard setup (`code` and `cargo` in `$PATH`, etc), use this: | ||
30 | |||
31 | ``` | ||
32 | # clone the repo | ||
33 | $ git clone https://github.com/rust-analyzer/rust-analyzer && cd rust-analyzer | ||
34 | |||
35 | # install both the language server and VS Code extension | ||
36 | $ cargo xtask install | ||
37 | |||
38 | # alternatively, install only the server. Binary name is `rust-analyzer`. | ||
39 | $ cargo xtask install --server | ||
40 | ``` | ||
41 | |||
42 | For non-standard setup of VS Code and other editors, or if the language server | ||
43 | cannot start, see [./docs/user](./docs/user). | ||
44 | 20 | ||
45 | ## Documentation | 21 | ## Documentation |
46 | 22 | ||
@@ -48,7 +24,7 @@ If you want to **contribute** to rust-analyzer or are just curious about how | |||
48 | things work under the hood, check the [./docs/dev](./docs/dev) folder. | 24 | things work under the hood, check the [./docs/dev](./docs/dev) folder. |
49 | 25 | ||
50 | If you want to **use** rust-analyzer's language server with your editor of | 26 | If you want to **use** rust-analyzer's language server with your editor of |
51 | choice, check [./docs/user](./docs/user) folder. It also contains some tips & tricks to help | 27 | choice, check [the manual](https://rust-analyzer.github.io/manual.html) folder. It also contains some tips & tricks to help |
52 | you be more productive when using rust-analyzer. | 28 | you be more productive when using rust-analyzer. |
53 | 29 | ||
54 | ## Getting in touch | 30 | ## Getting in touch |