]> git.lizzy.rs Git - rust.git/blob - README.md
Auto merge of #12101 - Veykril:simplify, r=Veykril
[rust.git] / README.md
1 <p align="center">
2   <img
3     src="https://raw.githubusercontent.com/rust-analyzer/rust-analyzer/master/assets/logo-wide.svg"
4     alt="rust-analyzer logo">
5 </p>
6
7 rust-analyzer is a modular compiler frontend for the Rust language.
8 It is a part of a larger rls-2.0 effort to create excellent IDE support for Rust.
9
10 ## Quick Start
11
12 https://rust-analyzer.github.io/manual.html#installation
13
14 ## Documentation
15
16 If you want to **contribute** to rust-analyzer or are just curious about how
17 things work under the hood, check the [./docs/dev](./docs/dev) folder.
18
19 If you want to **use** rust-analyzer's language server with your editor of
20 choice, check [the manual](https://rust-analyzer.github.io/manual.html) folder.
21 It also contains some tips & tricks to help you be more productive when using rust-analyzer.
22
23 ## Security and Privacy
24
25 See the corresponding sections of [the manual](https://rust-analyzer.github.io/manual.html#security).
26
27 ## Communication
28
29 For usage and troubleshooting requests, please use "IDEs and Editors" category of the Rust forum:
30
31 https://users.rust-lang.org/c/ide/14
32
33 For questions about development and implementation, join rust-analyzer working group on Zulip:
34
35 https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frust-analyzer
36
37 ## Quick Links
38
39 * Website: https://rust-analyzer.github.io/
40 * Metrics: https://rust-analyzer.github.io/metrics/
41 * API docs: https://rust-lang.github.io/rust-analyzer/ide/
42 * Changelog: https://rust-analyzer.github.io/thisweek
43
44 ## License
45
46 Rust analyzer is primarily distributed under the terms of both the MIT
47 license and the Apache License (Version 2.0).
48
49 See LICENSE-APACHE and LICENSE-MIT for details.