X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=README.md;h=8bb0517ed5abbe1518ea4b510d586da047c07b54;hb=188c0e424cb447d1a16cabe622a9787ab0b18dff;hp=13d81d4ae8a4b62614d9a71bb01c646ff84ab884;hpb=c447fe9bc06006a7080da782cf67d739c91b534c;p=rust.git diff --git a/README.md b/README.md index 13d81d4ae8a..8bb0517ed5a 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,15 @@

- rust-analyzer logo + rust-analyzer logo

-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: +rust-analyzer is a 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. -https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Fwg-rls-2.2E0 +## Quick Start -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 - -rust-analyzer is a work-in-progress, so 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 the language server itself -* latest stable npm and VS Code for VS Code extension - -To quickly install the rust-analyzer language server and 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 `rust-analyzer`. -$ 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 @@ -48,19 +17,29 @@ 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 -you be more productive when using rust-analyzer. +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. + +## Security and Privacy + +See the corresponding sections of [the manual](https://rust-analyzer.github.io/manual.html#security). + +## Communication + +For usage and troubleshooting requests, please use "IDEs and Editors" category of the Rust forum: -## Getting in touch +https://users.rust-lang.org/c/ide/14 -We are on the rust-lang Zulip! +For questions about development and implementation, join rust-analyzer working group on Zulip: -https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frls-2.2E0 +https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frust-analyzer ## Quick Links -* API docs: https://rust-analyzer.github.io/rust-analyzer/ra_ide/ * Website: https://rust-analyzer.github.io/ +* Metrics: https://rust-analyzer.github.io/metrics/ +* API docs: https://rust-lang.github.io/rust-analyzer/ide/ +* Changelog: https://rust-analyzer.github.io/thisweek ## License