diff options
author | Aleksey Kladov <[email protected]> | 2019-03-20 07:00:54 +0000 |
---|---|---|
committer | Aleksey Kladov <[email protected]> | 2019-03-20 07:00:54 +0000 |
commit | 206bbe9c93f3fd33922c9e00cfb263b980a79ca2 (patch) | |
tree | 1231f5676e4ed47ffad3e058ba0f4d56ed8d8fac | |
parent | 91203699eccf63ee21fee236f493c361c64b5d86 (diff) |
README is short and up to the point
-rw-r--r-- | README.md | 44 |
1 files changed, 22 insertions, 22 deletions
@@ -13,32 +13,37 @@ Work on the Rust Analyzer is sponsored by | |||
13 | 13 | ||
14 | [![Ferrous Systems](https://ferrous-systems.com/images/ferrous-logo-text.svg)](https://ferrous-systems.com/) | 14 | [![Ferrous Systems](https://ferrous-systems.com/images/ferrous-logo-text.svg)](https://ferrous-systems.com/) |
15 | 15 | ||
16 | ## Quick Start | 16 | ## Language Server Quick Start |
17 | 17 | ||
18 | Rust analyzer builds on Rust >= 1.31.0 and uses the 2018 edition. | 18 | Rust Analyzer is a work-in-progress, so you'll have to build it from source, and |
19 | you might encounter critical bugs. That said, it is complete enough to provide a | ||
20 | useful IDE experience and some people use it as a daily driver. | ||
19 | 21 | ||
20 | ``` | 22 | To build rust-analyzer, you need: |
21 | # run tests | ||
22 | $ cargo test | ||
23 | 23 | ||
24 | # show syntax tree of a Rust file | 24 | * latest stable rust for language server itself |
25 | $ cargo run --package ra_cli parse < crates/ra_syntax/src/lib.rs | 25 | * latest stable npm and VS Code for VS Code extension (`code` should be a path) |
26 | 26 | ||
27 | # show symbols of a Rust file | 27 | For setup for other languages, see [./docs/users]. |
28 | $ cargo run --package ra_cli symbols < crates/ra_syntax/src/lib.rs | ||
29 | 28 | ||
30 | # install the language server | ||
31 | $ cargo install-lsp | ||
32 | or | ||
33 | $ cargo install --path crates/ra_lsp_server | ||
34 | ``` | 29 | ``` |
30 | # clone the repo | ||
31 | $ git clone https://github.com/rust-analyzer/rust-analyzer && cd rust-analyzer | ||
35 | 32 | ||
36 | See [these instructions](./editors/README.md) for VS Code setup and the list of | 33 | # install both the language server and VS Code extension |
37 | features (some of which are VS Code specific). | 34 | $ cargo install-code |
35 | |||
36 | # alternatively, install only the server. Binary name is `ra_lsp_server`. | ||
37 | $ cargo install-lsp | ||
38 | ``` | ||
39 | ## Documentation | ||
38 | 40 | ||
39 | ## Debugging | 41 | If you want to **contribute** to rust-analyzer or just curious about how things work |
42 | under the hood, check the [./docs/dev] folder. | ||
40 | 43 | ||
41 | See [these instructions](./DEBUGGING.md) on how to debug the vscode extension and the lsp server. | 44 | If you want to **use** rust-analyzer's language server with your editor of |
45 | choice, check [./docs/users] folder. It also contains some tips & tricks to help | ||
46 | you be more productive when using rust-analyzer. | ||
42 | 47 | ||
43 | ## Getting in touch | 48 | ## Getting in touch |
44 | 49 | ||
@@ -46,11 +51,6 @@ We are on the rust-lang Zulip! | |||
46 | 51 | ||
47 | https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frls-2.2E0 | 52 | https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frls-2.2E0 |
48 | 53 | ||
49 | ## Contributing | ||
50 | |||
51 | See [CONTRIBUTING.md](./CONTRIBUTING.md) and [ARCHITECTURE.md](./ARCHITECTURE.md) | ||
52 | |||
53 | |||
54 | ## License | 54 | ## License |
55 | 55 | ||
56 | Rust analyzer is primarily distributed under the terms of both the MIT | 56 | Rust analyzer is primarily distributed under the terms of both the MIT |