2020-01-15 08:41:04 -06:00
|
|
|
<p align="center">
|
2020-08-28 06:42:12 -05:00
|
|
|
<img
|
|
|
|
|
src="https://raw.githubusercontent.com/rust-analyzer/rust-analyzer/master/assets/logo-wide.svg"
|
|
|
|
|
alt="rust-analyzer logo">
|
2020-01-15 08:41:04 -06:00
|
|
|
</p>
|
2018-01-10 12:58:38 -06:00
|
|
|
|
2021-03-29 08:29:11 -05:00
|
|
|
rust-analyzer is a modular compiler frontend for the Rust language.
|
2020-07-24 17:18:21 -05:00
|
|
|
It is a part of a larger rls-2.0 effort to create excellent IDE support for Rust.
|
2018-01-10 12:58:38 -06:00
|
|
|
|
2020-02-09 06:34:56 -06:00
|
|
|
Work on rust-analyzer is sponsored by
|
2018-10-22 07:59:01 -05:00
|
|
|
|
2019-05-21 09:10:08 -05:00
|
|
|
[<img src="https://user-images.githubusercontent.com/1711539/58105231-cf306900-7bee-11e9-83d8-9f1102e59d29.png" alt="Ferrous Systems" width="300">](https://ferrous-systems.com/)
|
2019-05-21 05:27:07 -05:00
|
|
|
- [Mozilla](https://www.mozilla.org/en-US/)
|
2020-06-15 08:06:03 -05:00
|
|
|
- [Embark Studios](https://embark-studios.com/)
|
2018-10-22 07:59:01 -05:00
|
|
|
|
2020-03-05 10:26:47 -06:00
|
|
|
## Quick Start
|
2018-08-24 10:14:21 -05:00
|
|
|
|
2020-03-05 10:26:47 -06:00
|
|
|
https://rust-analyzer.github.io/manual.html#installation
|
2019-09-18 06:24:20 -05:00
|
|
|
|
2019-03-20 02:00:54 -05:00
|
|
|
## Documentation
|
2018-08-24 10:14:21 -05:00
|
|
|
|
2020-02-09 06:34:56 -06:00
|
|
|
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.
|
2019-01-18 04:59:08 -06:00
|
|
|
|
2019-03-20 02:00:54 -05:00
|
|
|
If you want to **use** rust-analyzer's language server with your editor of
|
2020-07-24 17:18:21 -05:00
|
|
|
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.
|
2019-01-18 04:59:08 -06:00
|
|
|
|
2021-06-15 12:05:16 -05:00
|
|
|
## Security and Privacy
|
|
|
|
|
|
|
|
|
|
See the corresponding sections of [the manual](https://rust-analyzer.github.io/manual.html#security).
|
|
|
|
|
|
2020-05-28 03:19:01 -05:00
|
|
|
## Communication
|
2018-09-16 06:29:34 -05:00
|
|
|
|
2020-05-28 03:19:01 -05:00
|
|
|
For usage and troubleshooting requests, please use "IDEs and Editors" category of the Rust forum:
|
|
|
|
|
|
|
|
|
|
https://users.rust-lang.org/c/ide/14
|
|
|
|
|
|
2021-04-06 10:38:01 -05:00
|
|
|
For questions about development and implementation, join rust-analyzer working group on Zulip:
|
2018-09-16 06:29:34 -05:00
|
|
|
|
2021-04-06 10:38:01 -05:00
|
|
|
https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frust-analyzer
|
2018-10-09 13:30:41 -05:00
|
|
|
|
2019-03-26 07:38:46 -05:00
|
|
|
## Quick Links
|
|
|
|
|
|
2019-12-16 11:41:03 -06:00
|
|
|
* Website: https://rust-analyzer.github.io/
|
2020-07-24 17:18:21 -05:00
|
|
|
* Metrics: https://rust-analyzer.github.io/metrics/
|
2020-08-13 10:42:52 -05:00
|
|
|
* API docs: https://rust-analyzer.github.io/rust-analyzer/ide/
|
2021-02-28 06:19:32 -06:00
|
|
|
* Changelog: https://rust-analyzer.github.io/thisweek
|
2019-11-19 15:02:44 -06:00
|
|
|
|
2018-01-10 13:47:04 -06:00
|
|
|
## License
|
|
|
|
|
|
2018-09-16 07:36:09 -05:00
|
|
|
Rust analyzer is primarily distributed under the terms of both the MIT
|
|
|
|
|
license and the Apache License (Version 2.0).
|
2018-01-10 13:47:04 -06:00
|
|
|
|
|
|
|
|
See LICENSE-APACHE and LICENSE-MIT for details.
|
