]> git.lizzy.rs Git - rust.git/blob - README.md
Apply review fixes
[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 Work on rust-analyzer is sponsored by
11
12 [<img src="https://user-images.githubusercontent.com/1711539/58105231-cf306900-7bee-11e9-83d8-9f1102e59d29.png" alt="Ferrous Systems" width="300">](https://ferrous-systems.com/)
13 - [Mozilla](https://www.mozilla.org/en-US/)
14 - [Embark Studios](https://embark-studios.com/)
15
16 ## Quick Start
17
18 https://rust-analyzer.github.io/manual.html#installation
19
20 ## Documentation
21
22 If you want to **contribute** to rust-analyzer or are just curious about how
23 things work under the hood, check the [./docs/dev](./docs/dev) folder.
24
25 If you want to **use** rust-analyzer's language server with your editor of
26 choice, check [the manual](https://rust-analyzer.github.io/manual.html) folder.
27 It also contains some tips & tricks to help you be more productive when using rust-analyzer.
28
29 ## Security and Privacy
30
31 See the corresponding sections of [the manual](https://rust-analyzer.github.io/manual.html#security).
32
33 ## Communication
34
35 For usage and troubleshooting requests, please use "IDEs and Editors" category of the Rust forum:
36
37 https://users.rust-lang.org/c/ide/14
38
39 For questions about development and implementation, join rust-analyzer working group on Zulip:
40
41 https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frust-analyzer
42
43 ## Quick Links
44
45 * Website: https://rust-analyzer.github.io/
46 * Metrics: https://rust-analyzer.github.io/metrics/
47 * API docs: https://rust-analyzer.github.io/rust-analyzer/ide/
48 * Changelog: https://rust-analyzer.github.io/thisweek
49
50 ## License
51
52 Rust analyzer is primarily distributed under the terms of both the MIT
53 license and the Apache License (Version 2.0).
54
55 See LICENSE-APACHE and LICENSE-MIT for details.