diff options
Diffstat (limited to '')
-rw-r--r-- | src/tools/rust-analyzer/README.md | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/src/tools/rust-analyzer/README.md b/src/tools/rust-analyzer/README.md new file mode 100644 index 000000000..8bb0517ed --- /dev/null +++ b/src/tools/rust-analyzer/README.md @@ -0,0 +1,49 @@ +<p align="center"> + <img + src="https://raw.githubusercontent.com/rust-analyzer/rust-analyzer/master/assets/logo-wide.svg" + alt="rust-analyzer logo"> +</p> + +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. + +## Quick Start + +https://rust-analyzer.github.io/manual.html#installation + +## Documentation + +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 [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: + +https://users.rust-lang.org/c/ide/14 + +For questions about development and implementation, join rust-analyzer working group on Zulip: + +https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frust-analyzer + +## Quick Links + +* 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 +license and the Apache License (Version 2.0). + +See LICENSE-APACHE and LICENSE-MIT for details. |