2020-01-15 14:41:04 +00:00
|
|
|
<p align="center">
|
2020-08-28 11:42:12 +00:00
|
|
|
<img
|
|
|
|
|
src="https://raw.githubusercontent.com/rust-analyzer/rust-analyzer/master/assets/logo-wide.svg"
|
|
|
|
|
alt="rust-analyzer logo">
|
2020-01-15 14:41:04 +00:00
|
|
|
</p>
|
2018-01-10 18:58:38 +00:00
|
|
|
|
2020-07-24 22:18:21 +00:00
|
|
|
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.
|
2018-01-10 18:58:38 +00:00
|
|
|
|
2020-02-09 12:34:56 +00:00
|
|
|
Work on rust-analyzer is sponsored by
|
2018-10-22 12:59:01 +00:00
|
|
|
|
2019-05-21 14:10:08 +00: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 10:27:07 +00:00
|
|
|
- [Mozilla](https://www.mozilla.org/en-US/)
|
2020-06-15 13:06:03 +00:00
|
|
|
- [Embark Studios](https://embark-studios.com/)
|
2020-01-10 14:07:27 +00:00
|
|
|
- [freiheit.com](https://www.freiheit.com)
|
2018-10-22 12:59:01 +00:00
|
|
|
|
2020-03-05 16:26:47 +00:00
|
|
|
## Quick Start
|
2018-08-24 15:14:21 +00:00
|
|
|
|
2020-03-05 16:26:47 +00:00
|
|
|
https://rust-analyzer.github.io/manual.html#installation
|
2019-09-18 11:24:20 +00:00
|
|
|
|
2019-03-20 07:00:54 +00:00
|
|
|
## Documentation
|
2018-08-24 15:14:21 +00:00
|
|
|
|
2020-02-09 12:34:56 +00: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 10:59:08 +00:00
|
|
|
|
2019-03-20 07:00:54 +00:00
|
|
|
If you want to **use** rust-analyzer's language server with your editor of
|
2020-07-24 22:18:21 +00: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 10:59:08 +00:00
|
|
|
|
2020-05-28 08:19:01 +00:00
|
|
|
## Communication
|
2018-09-16 11:29:34 +00:00
|
|
|
|
2020-05-28 08:19:01 +00:00
|
|
|
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 rls-2.0 working group on Zulip:
|
2018-09-16 11:29:34 +00:00
|
|
|
|
2019-02-12 14:55:02 +00:00
|
|
|
https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frls-2.2E0
|
2018-10-09 18:30:41 +00:00
|
|
|
|
2019-03-26 12:38:46 +00:00
|
|
|
## Quick Links
|
|
|
|
|
|
2019-12-16 17:41:03 +00:00
|
|
|
* Website: https://rust-analyzer.github.io/
|
2020-07-24 22:18:21 +00:00
|
|
|
* Metrics: https://rust-analyzer.github.io/metrics/
|
2020-08-13 15:42:52 +00:00
|
|
|
* API docs: https://rust-analyzer.github.io/rust-analyzer/ide/
|
2019-11-19 21:02:44 +00:00
|
|
|
|
2018-01-10 19:47:04 +00:00
|
|
|
## License
|
|
|
|
|
|
2018-09-16 12:36:09 +00:00
|
|
|
Rust analyzer is primarily distributed under the terms of both the MIT
|
|
|
|
|
license and the Apache License (Version 2.0).
|
2018-01-10 19:47:04 +00:00
|
|
|
|
|
|
|
|
See LICENSE-APACHE and LICENSE-MIT for details.
|
