mirror of
https://github.com/rust-lang/rust-analyzer
synced 2024-09-20 06:22:10 +00:00
50 lines
1.7 KiB
Markdown
50 lines
1.7 KiB
Markdown
<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 check out the [CONTRIBUTING.md](./CONTRIBUTING.md) or
|
|
if you 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.
|