X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=README.md;h=1e7c3e9b4344b7bce027dc481e04784aef244d1d;hb=0a88de809f13f3b4abe0ffa11ff87c6f845050bd;hp=4a76ea6e3dd1be7bea6a78db2a437d0a23832ec5;hpb=286930f1b6d5f2735efbcf8f1e8c559355b9f7a5;p=rust.git diff --git a/README.md b/README.md index 4a76ea6e3dd..1e7c3e9b434 100644 --- a/README.md +++ b/README.md @@ -2,59 +2,38 @@ rust-analyzer logo

-Rust Analyzer is an **experimental** modular compiler frontend for the Rust +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: +support for Rust. If you want to get involved, check the rls-2.0 working group: -https://github.com/rust-lang/compiler-team/tree/master/content/working-groups/rls-2.0 +https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Fwg-rls-2.2E0 -Work on the Rust Analyzer is sponsored by +Work on rust-analyzer is sponsored by [Ferrous Systems](https://ferrous-systems.com/) - [Mozilla](https://www.mozilla.org/en-US/) - [freiheit.com](https://www.freiheit.com) -## Language Server Quick Start +## Quick Start -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. - -To build rust-analyzer, you need: - -* latest stable rust for language server itself -* latest stable npm and VS Code for VS Code extension - -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 xtask install - -# alternatively, install only the server. Binary name is `ra_lsp_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). +https://rust-analyzer.github.io/manual.html#installation ## 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 **contribute** to rust-analyzer or are 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 +choice, check [the manual](https://rust-analyzer.github.io/manual.html) folder. It also contains some tips & tricks to help you be more productive when using rust-analyzer. -## Getting in touch +## Communication + +For usage and troubleshooting requests, please use "IDEs and Editors" category of the Rust forum: + +https://users.rust-lang.org/c/ide/14 -We are on the rust-lang Zulip! +For questions about development and implementation, join rls-2.0 working group on Zulip: https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frls-2.2E0