aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAleksey Kladov <[email protected]>2019-03-20 07:00:54 +0000
committerAleksey Kladov <[email protected]>2019-03-20 07:00:54 +0000
commit206bbe9c93f3fd33922c9e00cfb263b980a79ca2 (patch)
tree1231f5676e4ed47ffad3e058ba0f4d56ed8d8fac /README.md
parent91203699eccf63ee21fee236f493c361c64b5d86 (diff)
README is short and up to the point
Diffstat (limited to 'README.md')
-rw-r--r--README.md44
1 files changed, 22 insertions, 22 deletions
diff --git a/README.md b/README.md
index acce7219e..4cada764d 100644
--- a/README.md
+++ b/README.md
@@ -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
18Rust analyzer builds on Rust >= 1.31.0 and uses the 2018 edition. 18Rust Analyzer is a work-in-progress, so you'll have to build it from source, and
19you might encounter critical bugs. That said, it is complete enough to provide a
20useful IDE experience and some people use it as a daily driver.
19 21
20``` 22To 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 27For 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
32or
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
36See [these instructions](./editors/README.md) for VS Code setup and the list of 33# install both the language server and VS Code extension
37features (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 41If you want to **contribute** to rust-analyzer or just curious about how things work
42under the hood, check the [./docs/dev] folder.
40 43
41See [these instructions](./DEBUGGING.md) on how to debug the vscode extension and the lsp server. 44If you want to **use** rust-analyzer's language server with your editor of
45choice, check [./docs/users] folder. It also contains some tips & tricks to help
46you 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
47https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frls-2.2E0 52https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frls-2.2E0
48 53
49## Contributing
50
51See [CONTRIBUTING.md](./CONTRIBUTING.md) and [ARCHITECTURE.md](./ARCHITECTURE.md)
52
53
54## License 54## License
55 55
56Rust analyzer is primarily distributed under the terms of both the MIT 56Rust analyzer is primarily distributed under the terms of both the MIT