diff options
author | Kevin DeLorey <[email protected]> | 2020-02-09 16:25:47 +0000 |
---|---|---|
committer | Kevin DeLorey <[email protected]> | 2020-02-09 16:37:43 +0000 |
commit | a957c473fdb79880c39b73dc9e0c923093cf16ac (patch) | |
tree | f998b548f530ce604651e0e6af314ed2ec74b3b5 /README.md | |
parent | 22caf982b99c54058e2e9200aeea0e61cada284a (diff) | |
parent | 1b9b13b4b4a75b5531c3f046ce6bf72d681f2732 (diff) |
Merge branch 'master' into kdelorey/complete-trait-impl
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 25 |
1 files changed, 12 insertions, 13 deletions
@@ -2,14 +2,13 @@ | |||
2 | <img src="https://user-images.githubusercontent.com/1711539/72443316-5a79f280-37ae-11ea-858f-035209ece2dd.png" alt="rust-analyzer logo"> | 2 | <img src="https://user-images.githubusercontent.com/1711539/72443316-5a79f280-37ae-11ea-858f-035209ece2dd.png" alt="rust-analyzer logo"> |
3 | </p> | 3 | </p> |
4 | 4 | ||
5 | Rust Analyzer is an **experimental** modular compiler frontend for the Rust | 5 | rust-analyzer is an **experimental** modular compiler frontend for the Rust |
6 | language. It is a part of a larger rls-2.0 effort to create excellent IDE | 6 | language. It is a part of a larger rls-2.0 effort to create excellent IDE |
7 | support for Rust. If you want to get involved, check the rls-2.0 working group | 7 | support for Rust. If you want to get involved, check the rls-2.0 working group: |
8 | in the compiler-team repository: | ||
9 | 8 | ||
10 | https://github.com/rust-lang/compiler-team/tree/master/content/working-groups/rls-2.0 | 9 | https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Fwg-rls-2.2E0 |
11 | 10 | ||
12 | Work on the Rust Analyzer is sponsored by | 11 | Work on rust-analyzer is sponsored by |
13 | 12 | ||
14 | [<img src="https://user-images.githubusercontent.com/1711539/58105231-cf306900-7bee-11e9-83d8-9f1102e59d29.png" alt="Ferrous Systems" width="300">](https://ferrous-systems.com/) | 13 | [<img src="https://user-images.githubusercontent.com/1711539/58105231-cf306900-7bee-11e9-83d8-9f1102e59d29.png" alt="Ferrous Systems" width="300">](https://ferrous-systems.com/) |
15 | - [Mozilla](https://www.mozilla.org/en-US/) | 14 | - [Mozilla](https://www.mozilla.org/en-US/) |
@@ -17,17 +16,17 @@ Work on the Rust Analyzer is sponsored by | |||
17 | 16 | ||
18 | ## Language Server Quick Start | 17 | ## Language Server Quick Start |
19 | 18 | ||
20 | Rust Analyzer is a work-in-progress, so you'll have to build it from source, and | 19 | rust-analyzer is a work-in-progress, so you might encounter critical bugs. That |
21 | you might encounter critical bugs. That said, it is complete enough to provide a | 20 | said, it is complete enough to provide a useful IDE experience and some people |
22 | useful IDE experience and some people use it as a daily driver. | 21 | use it as a daily driver. |
23 | 22 | ||
24 | To build rust-analyzer, you need: | 23 | To build rust-analyzer, you need: |
25 | 24 | ||
26 | * latest stable rust for language server itself | 25 | * latest stable Rust for the language server itself |
27 | * latest stable npm and VS Code for VS Code extension | 26 | * latest stable npm and VS Code for VS Code extension |
28 | 27 | ||
29 | To quickly install rust-analyzer with VS Code extension with standard setup | 28 | To quickly install the rust-analyzer language server and VS Code extension with |
30 | (`code` and `cargo` in `$PATH`, etc), use this: | 29 | standard setup (`code` and `cargo` in `$PATH`, etc), use this: |
31 | 30 | ||
32 | ``` | 31 | ``` |
33 | # clone the repo | 32 | # clone the repo |
@@ -45,8 +44,8 @@ cannot start, see [./docs/user](./docs/user). | |||
45 | 44 | ||
46 | ## Documentation | 45 | ## Documentation |
47 | 46 | ||
48 | If you want to **contribute** to rust-analyzer or just curious about how things work | 47 | If you want to **contribute** to rust-analyzer or are just curious about how |
49 | under the hood, check the [./docs/dev](./docs/dev) folder. | 48 | things work under the hood, check the [./docs/dev](./docs/dev) folder. |
50 | 49 | ||
51 | If you want to **use** rust-analyzer's language server with your editor of | 50 | If you want to **use** rust-analyzer's language server with your editor of |
52 | choice, check [./docs/user](./docs/user) folder. It also contains some tips & tricks to help | 51 | choice, check [./docs/user](./docs/user) folder. It also contains some tips & tricks to help |