aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 12 insertions, 13 deletions
diff --git a/README.md b/README.md
index 4a76ea6e3..fabb8479d 100644
--- a/README.md
+++ b/README.md
@@ -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
5Rust Analyzer is an **experimental** modular compiler frontend for the Rust 5rust-analyzer is an **experimental** modular compiler frontend for the Rust
6language. It is a part of a larger rls-2.0 effort to create excellent IDE 6language. It is a part of a larger rls-2.0 effort to create excellent IDE
7support for Rust. If you want to get involved, check the rls-2.0 working group 7support for Rust. If you want to get involved, check the rls-2.0 working group:
8in the compiler-team repository:
9 8
10https://github.com/rust-lang/compiler-team/tree/master/content/working-groups/rls-2.0 9https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Fwg-rls-2.2E0
11 10
12Work on the Rust Analyzer is sponsored by 11Work 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
20Rust Analyzer is a work-in-progress, so you'll have to build it from source, and 19rust-analyzer is a work-in-progress, so you might encounter critical bugs. That
21you might encounter critical bugs. That said, it is complete enough to provide a 20said, it is complete enough to provide a useful IDE experience and some people
22useful IDE experience and some people use it as a daily driver. 21use it as a daily driver.
23 22
24To build rust-analyzer, you need: 23To 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
29To quickly install rust-analyzer with VS Code extension with standard setup 28To quickly install the rust-analyzer language server and VS Code extension with
30(`code` and `cargo` in `$PATH`, etc), use this: 29standard 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
48If you want to **contribute** to rust-analyzer or just curious about how things work 47If you want to **contribute** to rust-analyzer or are just curious about how
49under the hood, check the [./docs/dev](./docs/dev) folder. 48things work under the hood, check the [./docs/dev](./docs/dev) folder.
50 49
51If you want to **use** rust-analyzer's language server with your editor of 50If you want to **use** rust-analyzer's language server with your editor of
52choice, check [./docs/user](./docs/user) folder. It also contains some tips & tricks to help 51choice, check [./docs/user](./docs/user) folder. It also contains some tips & tricks to help