]> git.lizzy.rs Git - rust.git/blob - README.md
Merge #5527
[rust.git] / README.md
1 <p align="center">
2   <img src="https://user-images.githubusercontent.com/1711539/72443316-5a79f280-37ae-11ea-858f-035209ece2dd.png" alt="rust-analyzer logo">
3 </p>
4
5 rust-analyzer is an **experimental** modular compiler frontend for the Rust language.
6 It is a part of a larger rls-2.0 effort to create excellent IDE support for Rust.
7
8 Work on rust-analyzer is sponsored by
9
10 [<img src="https://user-images.githubusercontent.com/1711539/58105231-cf306900-7bee-11e9-83d8-9f1102e59d29.png" alt="Ferrous Systems" width="300">](https://ferrous-systems.com/)
11 - [Mozilla](https://www.mozilla.org/en-US/)
12 - [Embark Studios](https://embark-studios.com/)
13 - [freiheit.com](https://www.freiheit.com)
14
15 ## Quick Start
16
17 https://rust-analyzer.github.io/manual.html#installation
18
19 ## Documentation
20
21 If you want to **contribute** to rust-analyzer or are just curious about how
22 things work under the hood, check the [./docs/dev](./docs/dev) folder.
23
24 If you want to **use** rust-analyzer's language server with your editor of
25 choice, check [the manual](https://rust-analyzer.github.io/manual.html) folder.
26 It also contains some tips & tricks to help you be more productive when using rust-analyzer.
27
28 ## Communication
29
30 For usage and troubleshooting requests, please use "IDEs and Editors" category of the Rust forum:
31
32 https://users.rust-lang.org/c/ide/14
33
34 For questions about development and implementation, join rls-2.0 working group on Zulip:
35
36 https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frls-2.2E0
37
38 ## Quick Links
39
40 * Website: https://rust-analyzer.github.io/
41 * Metrics: https://rust-analyzer.github.io/metrics/
42 * API docs: https://rust-analyzer.github.io/rust-analyzer/ra_ide/
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.