3 [![Build Status](https://travis-ci.org/rust-analyzer/rust-analyzer.svg?branch=master)](https://travis-ci.org/rust-analyzer/rust-analyzer)
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 in the compiler-team repository:
10 https://github.com/rust-lang/compiler-team/tree/master/content/working-groups/rls-2.0
12 Work on the Rust Analyzer is sponsored by
14 [<img src="https://user-images.githubusercontent.com/1711539/58105231-cf306900-7bee-11e9-83d8-9f1102e59d29.png" alt="Ferrous Systems" width="300">](https://ferrous-systems.com/)
15 - [Mozilla](https://www.mozilla.org/en-US/)
17 ## Language Server Quick Start
19 Rust Analyzer is a work-in-progress, so you'll have to build it from source, and
20 you might encounter critical bugs. That said, it is complete enough to provide a
21 useful IDE experience and some people use it as a daily driver.
23 To build rust-analyzer, you need:
25 * latest stable rust for language server itself
26 * latest stable npm and VS Code for VS Code extension
28 To quickly install rust-analyzer with VS Code extension with standard setup
29 (`code` and `cargo` in `$PATH`, etc), use this:
33 $ git clone https://github.com/rust-analyzer/rust-analyzer && cd rust-analyzer
35 # install both the language server and VS Code extension
38 # alternatively, install only the server. Binary name is `ra_lsp_server`.
39 $ cargo xtask install --server
42 For non-standard setup of VS Code and other editors, see [./docs/user](./docs/user).
46 If you want to **contribute** to rust-analyzer or just curious about how things work
47 under the hood, check the [./docs/dev](./docs/dev) folder.
49 If you want to **use** rust-analyzer's language server with your editor of
50 choice, check [./docs/user](./docs/user) folder. It also contains some tips & tricks to help
51 you be more productive when using rust-analyzer.
55 We are on the rust-lang Zulip!
57 https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frls-2.2E0
61 * Work List: https://paper.dropbox.com/doc/RLS-2.0-work-list--AZ3BgHKKCtqszbsi3gi6sjchAQ-42vbnxzuKq2lKwW0mkn8Y
62 * API docs: https://rust-analyzer.github.io/rust-analyzer/ra_ide_api/
63 * CI: https://travis-ci.org/rust-analyzer/rust-analyzer
67 Rust analyzer is primarily distributed under the terms of both the MIT
68 license and the Apache License (Version 2.0).
70 See LICENSE-APACHE and LICENSE-MIT for details.