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 ## Language Server Quick Start
  18
  19 rust-analyzer is a work-in-progress, so you might encounter critical bugs. That
  20 said, it is complete enough to provide a useful IDE experience and some people
  21 use it as a daily driver.
  22
  23 To build rust-analyzer, you need:
  24
  25 * latest stable Rust for the language server itself
  26 * latest stable npm and VS Code for VS Code extension
  27
  28 To quickly install the rust-analyzer language server and VS Code extension with
  29 standard setup (`code` and `cargo` in `$PATH`, etc), use this:
  30
  31 ```
  32 # clone the repo
  33 $ git clone https://github.com/rust-analyzer/rust-analyzer && cd rust-analyzer
  34
  35 # install both the language server and VS Code extension
  36 $ cargo xtask install
  37
  38 # alternatively, install only the server. Binary name is `rust-analyzer`.
  39 $ cargo xtask install --server
  40 ```
  41
  42 For non-standard setup of VS Code and other editors, or if the language server
  43 cannot start, see [./docs/user](./docs/user).
  44
  45 ## Documentation
  46
  47 If you want to **contribute** to rust-analyzer or are just curious about how
  48 things work under the hood, check the [./docs/dev](./docs/dev) folder.
  49
  50 If you want to **use** rust-analyzer's language server with your editor of
  51 choice, check [./docs/user](./docs/user) folder. It also contains some tips & tricks to help
  52 you be more productive when using rust-analyzer.
  53
  54 ## Getting in touch
  55
  56 We are on the rust-lang Zulip!
  57
  58 https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frls-2.2E0
  59
  60 ## Quick Links
  61
  62 * API docs: https://rust-analyzer.github.io/rust-analyzer/ra_ide/
  63 * Website: https://rust-analyzer.github.io/
  64
  65 ## License
  66
  67 Rust analyzer is primarily distributed under the terms of both the MIT
  68 license and the Apache License (Version 2.0).
  69
  70 See LICENSE-APACHE and LICENSE-MIT for details.