rust/README.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

51 lines
1.7 KiB
Markdown
Raw Normal View History

2020-01-15 08:41:04 -06:00
<p align="center">
<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-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
2024-04-18 03:24:40 -05:00
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.
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.
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
For questions about development and implementation, join rust-analyzer working group on Zulip:
2018-09-16 06:29:34 -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/
2022-04-13 06:22:45 -05:00
* API docs: https://rust-lang.github.io/rust-analyzer/ide/
* Changelog: https://rust-analyzer.github.io/thisweek
2019-11-19 15:02:44 -06:00
2018-01-10 13:47:04 -06:00
## License
2022-08-01 06:47:09 -05:00
rust-analyzer is primarily distributed under the terms of both the MIT
2018-09-16 07:36:09 -05:00
license and the Apache License (Version 2.0).
2018-01-10 13:47:04 -06:00
See LICENSE-APACHE and LICENSE-MIT for details.