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/working-groups/rls-2.0
12 Work on the Rust Analyzer is sponsored by
14 [![Ferrous Systems](https://ferrous-systems.com/images/ferrous-logo-text.svg)](https://ferrous-systems.com/)
16 ## Language Server Quick Start
18 Rust Analyzer is a work-in-progress, so you'll have to build it from source, and
19 you might encounter critical bugs. That said, it is complete enough to provide a
20 useful IDE experience and some people use it as a daily driver.
22 To build rust-analyzer, you need:
24 * latest stable rust for language server itself
25 * latest stable npm and VS Code for VS Code extension (`code` should be a path)
27 For setup for other editors, see [./docs/user](./docs/user).
31 $ git clone https://github.com/rust-analyzer/rust-analyzer && cd rust-analyzer
33 # install both the language server and VS Code extension
36 # alternatively, install only the server. Binary name is `ra_lsp_server`.
41 If you want to **contribute** to rust-analyzer or just curious about how things work
42 under the hood, check the [./docs/dev](./docs/dev) folder.
44 If you want to **use** rust-analyzer's language server with your editor of
45 choice, check [./docs/user](./docs/user) folder. It also contains some tips & tricks to help
46 you be more productive when using rust-analyzer.
50 We are on the rust-lang Zulip!
52 https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frls-2.2E0
56 Rust analyzer is primarily distributed under the terms of both the MIT
57 license and the Apache License (Version 2.0).
59 See LICENSE-APACHE and LICENSE-MIT for details.