X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=README.md;h=e0154241680c657868d4ea50244590f4a881d36a;hb=b656751536491706f66cc72256df56906c59297b;hp=89d495aabb2ef758c851913b3c57190502471f1b;hpb=9a44f627be0b3c49184e3ad594849f9b5ed78daa;p=rust.git diff --git a/README.md b/README.md index 89d495aabb2..e0154241680 100644 --- a/README.md +++ b/README.md @@ -1,65 +1,52 @@ -# Rust Analyzer +

+ 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 -in the compiler-team repository: +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://github.com/rust-lang/compiler-team/tree/master/content/working-groups/rls-2.0 - -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/) +- [Embark Studios](https://embark-studios.com/) - [freiheit.com](https://www.freiheit.com) -## Language Server 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 +## Quick Start -To quickly install rust-analyzer with VS Code extension with standard setup -(`code` and `cargo` in `$PATH`, etc), use this: +https://rust-analyzer.github.io/manual.html#installation -``` -# clone the repo -$ git clone https://github.com/rust-analyzer/rust-analyzer && cd rust-analyzer +## Documentation -# install both the language server and VS Code extension -$ cargo xtask install +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. -# alternatively, install only the server. Binary name is `ra_lsp_server`. -$ cargo xtask install --server -``` +If you want to **use** rust-analyzer's language server with your editor of +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. -For non-standard setup of VS Code and other editors, or if the language server -cannot start, see [./docs/user](./docs/user). +## Security and Privacy -## Documentation +See the corresponding sections of [the manual](https://rust-analyzer.github.io/manual.html#security). -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. +## Communication -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. +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-analyzer.github.io/rust-analyzer/ide/ +* Changelog: https://rust-analyzer.github.io/thisweek ## License