-# Rust Analyzer
+<p align="center">
+ <img
+ src="https://raw.githubusercontent.com/rust-analyzer/rust-analyzer/master/assets/logo-wide.svg"
+ alt="rust-analyzer logo">
+</p>
-[](https://travis-ci.org/rust-analyzer/rust-analyzer)
+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.
-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:
+## Quick Start
-https://github.com/rust-lang/compiler-team/tree/master/content/docs/working-groups/rls-2.0
+https://rust-analyzer.github.io/manual.html#installation
-Work on the Rust Analyzer is sponsored by
-
-[<img src="https://user-images.githubusercontent.com/1711539/58105231-cf306900-7bee-11e9-83d8-9f1102e59d29.png" alt="Ferrous Systems" width="300">](https://ferrous-systems.com/)
-- [Mozilla](https://www.mozilla.org/en-US/)
-
-## 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 (`code` should be in path)
+## Documentation
-For setup for other editors, see [./docs/user](./docs/user).
+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.
-```
-# clone the repo
-$ git clone https://github.com/rust-analyzer/rust-analyzer && cd rust-analyzer
+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.
-# install both the language server and VS Code extension
-$ cargo install-code
+## Security and Privacy
-# alternatively, install only the server. Binary name is `ra_lsp_server`.
-$ cargo install-lsp
-```
-## 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
-* 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
+* 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
-Rust analyzer is primarily distributed under the terms of both the MIT
+rust-analyzer is primarily distributed under the terms of both the MIT
license and the Apache License (Version 2.0).
See LICENSE-APACHE and LICENSE-MIT for details.
projects / rust.git / blobdiff