[![Ferrous Systems](https://ferrous-systems.com/images/ferrous-logo-text.svg)](https://ferrous-systems.com/)
-## Quick Start
+## Language Server Quick Start
-Rust analyzer builds on Rust >= 1.31.0 and uses the 2018 edition.
+Rust Analyzer is a work-in-progress, so you'll have to build it from source, and
+you might encounter critical bugs. That said, it is complete enough to provide a
+useful IDE experience and some people use it as a daily driver.
-```
-# run tests
-$ cargo test
+To build rust-analyzer, you need:
-# show syntax tree of a Rust file
-$ cargo run --package ra_cli parse < crates/ra_syntax/src/lib.rs
+* latest stable rust for language server itself
+* latest stable npm and VS Code for VS Code extension (`code` should be a path)
-# show symbols of a Rust file
-$ cargo run --package ra_cli symbols < crates/ra_syntax/src/lib.rs
+For setup for other languages, see [./docs/users].
-# install the language server
-$ cargo install-lsp
-or
-$ cargo install --path crates/ra_lsp_server
```
+# clone the repo
+$ git clone https://github.com/rust-analyzer/rust-analyzer && cd rust-analyzer
-See [these instructions](./editors/README.md) for VS Code setup and the list of
-features (some of which are VS Code specific).
+# install both the language server and VS Code extension
+$ cargo install-code
+
+# alternatively, install only the server. Binary name is `ra_lsp_server`.
+$ cargo install-lsp
+```
+## Documentation
-## Debugging
+If you want to **contribute** to rust-analyzer or just curious about how things work
+under the hood, check the [./docs/dev] folder.
-See [these instructions](./DEBUGGING.md) on how to debug the vscode extension and the lsp server.
+If you want to **use** rust-analyzer's language server with your editor of
+choice, check [./docs/users] folder. It also contains some tips & tricks to help
+you be more productive when using rust-analyzer.
## Getting in touch
https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frls-2.2E0
-## Contributing
-
-See [CONTRIBUTING.md](./CONTRIBUTING.md) and [ARCHITECTURE.md](./ARCHITECTURE.md)
-
-
## License
Rust analyzer is primarily distributed under the terms of both the MIT