]> git.lizzy.rs Git - rust.git/blobdiff - README.md
Merge #2690
[rust.git] / README.md
index 5e9537ef1e7f65598980a086c16578303ab763cf..deaa147ba915bdcc930b3b89011c2042079bd69b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,13 +1,11 @@
 # 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/content/docs/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
 
@@ -23,20 +21,25 @@ useful IDE experience and some people use it as a daily driver.
 To build rust-analyzer, you need:
 
 * latest stable rust for language server itself
-* latest stable npm and VS Code for VS Code extension (`code` should be in path)
+* latest stable npm and VS Code for VS Code extension
 
-For setup for other editors, see [./docs/user](./docs/user).
+To quickly install rust-analyzer with VS Code extension with standard setup
+(`code` and `cargo` in `$PATH`, etc), use this:
 
 ```
 # clone the repo
 $ git clone https://github.com/rust-analyzer/rust-analyzer && cd rust-analyzer
 
 # install both the language server and VS Code extension
-$ cargo install-ra
+$ cargo xtask install
 
 # alternatively, install only the server. Binary name is `ra_lsp_server`.
-$ cargo install-ra --server
+$ cargo xtask install --server
 ```
+
+For non-standard setup of VS Code and other editors, or if the language server
+cannot start, see [./docs/user](./docs/user).
+
 ## Documentation
 
 If you want to **contribute** to rust-analyzer or just curious about how things work
@@ -54,9 +57,8 @@ https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frls-2.2E0
 
 ## Quick Links
 
-* Work List: https://paper.dropbox.com/doc/RLS-2.0-work-list--AZ3BgHKKCtqszbsi3gi6sjchAQ-42vbnxzuKq2lKwW0mkn8Y
-* API docs: https://rust-analyzer.github.io/rust-analyzer/ra_ide_api/index.html
-* CI: https://travis-ci.org/rust-analyzer/rust-analyzer
+* API docs: https://rust-analyzer.github.io/rust-analyzer/ra_ide/
+* Website: https://rust-analyzer.github.io/
 
 ## License