]> git.lizzy.rs Git - rust.git/blob - README.md
fix doctest inside impl block #4449
[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
6 language. It is a part of a larger rls-2.0 effort to create excellent IDE
7 support for Rust. If you want to get involved, check the rls-2.0 working group:
8
9 https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Fwg-rls-2.2E0
10
11 Work on rust-analyzer is sponsored by
12
13 [<img src="https://user-images.githubusercontent.com/1711539/58105231-cf306900-7bee-11e9-83d8-9f1102e59d29.png" alt="Ferrous Systems" width="300">](https://ferrous-systems.com/)
14 - [Mozilla](https://www.mozilla.org/en-US/)
15 - [freiheit.com](https://www.freiheit.com)
16
17 ## Quick Start
18
19 https://rust-analyzer.github.io/manual.html#installation
20
21 ## Documentation
22
23 If you want to **contribute** to rust-analyzer or are just curious about how
24 things work under the hood, check the [./docs/dev](./docs/dev) folder.
25
26 If you want to **use** rust-analyzer's language server with your editor of
27 choice, check [the manual](https://rust-analyzer.github.io/manual.html) folder. It also contains some tips & tricks to help
28 you be more productive when using rust-analyzer.
29
30 ## Getting in touch
31
32 We are on the rust-lang Zulip!
33
34 https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frls-2.2E0
35
36 ## Quick Links
37
38 * API docs: https://rust-analyzer.github.io/rust-analyzer/ra_ide/
39 * Website: https://rust-analyzer.github.io/
40
41 ## License
42
43 Rust analyzer is primarily distributed under the terms of both the MIT
44 license and the Apache License (Version 2.0).
45
46 See LICENSE-APACHE and LICENSE-MIT for details.