X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=README.md;h=deaa147ba915bdcc930b3b89011c2042079bd69b;hb=1327aed7f6289043091aa9179282030c6f13ddbe;hp=7c81413d93587f07bc0fe1b1161bbd205cb75de0;hpb=219b1573377caafaca1dc071f8513ec8be01f199;p=rust.git diff --git a/README.md b/README.md index 7c81413d935..deaa147ba91 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,16 @@ # Rust Analyzer -[![Build Status](https://travis-ci.org/rust-analyzer/rust-analyzer.svg?branch=master)](https://travis-ci.org/rust-analyzer/rust-analyzer) -[![Master docs](https://img.shields.io/badge/docs-master-blue.svg)](https://rust-analyzer.github.io/rust-analyzer/ra_ide_api/index.html) - 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/) +[Ferrous Systems](https://ferrous-systems.com/) +- [Mozilla](https://www.mozilla.org/en-US/) ## Language Server Quick Start @@ -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-code +$ cargo xtask install # alternatively, install only the server. Binary name is `ra_lsp_server`. -$ cargo install-lsp +$ 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 @@ -52,6 +55,11 @@ We are on the rust-lang Zulip! https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frls-2.2E0 +## Quick Links + +* API docs: https://rust-analyzer.github.io/rust-analyzer/ra_ide/ +* Website: https://rust-analyzer.github.io/ + ## License Rust analyzer is primarily distributed under the terms of both the MIT