Merge #2690

[rust.git] / README.md

diff --git a/README.md b/README.md
index acce7219e15ec0a9d0811cba0de0321d272ffaf1..deaa147ba915bdcc930b3b89011c2042079bd69b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,44 +1,53 @@
 # Rust Analyzer
 
-[![Build Status](https://travis-ci.org/rust-analyzer/rust-analyzer.svg?branch=master)](https://travis-ci.org/rust-analyzer/rust-analyzer)
-
 Rust Analyzer is an **experimental** modular compiler frontend for the Rust
 language. It is a part of a larger rls-2.0 effort to create excellent IDE
 support for Rust. If you want to get involved, check the rls-2.0 working group
 in the compiler-team repository:
 
-https://github.com/rust-lang/compiler-team/tree/master/working-groups/rls-2.0
+https://github.com/rust-lang/compiler-team/tree/master/content/working-groups/rls-2.0
 
 Work on the Rust Analyzer is sponsored by
 
-[![Ferrous Systems](https://ferrous-systems.com/images/ferrous-logo-text.svg)](https://ferrous-systems.com/)
+[<img src="https://user-images.githubusercontent.com/1711539/58105231-cf306900-7bee-11e9-83d8-9f1102e59d29.png" alt="Ferrous Systems" width="300">](https://ferrous-systems.com/)
+- [Mozilla](https://www.mozilla.org/en-US/)
 
-## 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
 
-# show symbols of a Rust file
-$ cargo run --package ra_cli symbols < crates/ra_syntax/src/lib.rs
+To quickly install rust-analyzer with VS Code extension with standard setup
+(`code` and `cargo` in `$PATH`, etc), use this:
 
-# 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 xtask install
+
+# alternatively, install only the server. Binary name is `ra_lsp_server`.
+$ cargo xtask install --server
+```
 
-## Debugging
+For non-standard setup of VS Code and other editors, or if the language server
+cannot start, see [./docs/user](./docs/user).
 
-See [these instructions](./DEBUGGING.md) on how to debug the vscode extension and the lsp server.
+## Documentation
+
+If you want to **contribute** to rust-analyzer or just curious about how things work
+under the hood, check the [./docs/dev](./docs/dev) folder.
+
+If you want to **use** rust-analyzer's language server with your editor of
+choice, check [./docs/user](./docs/user) folder. It also contains some tips & tricks to help
+you be more productive when using rust-analyzer.
 
 ## Getting in touch
 
@@ -46,10 +55,10 @@ We are on the rust-lang Zulip!
 
 https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frls-2.2E0
 
-## Contributing
-
-See [CONTRIBUTING.md](./CONTRIBUTING.md) and [ARCHITECTURE.md](./ARCHITECTURE.md)
+## Quick Links
 
+* API docs: https://rust-analyzer.github.io/rust-analyzer/ra_ide/
+* Website: https://rust-analyzer.github.io/
 
 ## License