README.md

   1 # Rust Analyzer
   2
   3 [![Build Status](https://travis-ci.org/rust-analyzer/rust-analyzer.svg?branch=master)](https://travis-ci.org/rust-analyzer/rust-analyzer)
   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 in the compiler-team repository:
   9
  10 https://github.com/rust-lang/compiler-team/tree/master/working-groups/rls-2.0
  11
  12 Work on the Rust Analyzer is sponsored by
  13
  14 - [![Ferrous Systems](https://ferrous-systems.com/images/ferrous-logo-text.svg)](https://ferrous-systems.com/)
  15 - [Mozilla](https://www.mozilla.org/en-US/)
  16
  17 ## Language Server Quick Start
  18
  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.
  22
  23 To build rust-analyzer, you need:
  24
  25 * latest stable rust for language server itself
  26 * latest stable npm and VS Code for VS Code extension (`code` should be in path)
  27
  28 For setup for other editors, see [./docs/user](./docs/user).
  29
  30 ```
  31 # clone the repo
  32 $ git clone https://github.com/rust-analyzer/rust-analyzer && cd rust-analyzer
  33
  34 # install both the language server and VS Code extension
  35 $ cargo install-code
  36
  37 # alternatively, install only the server. Binary name is `ra_lsp_server`.
  38 $ cargo install-lsp
  39 ```
  40 ## Documentation
  41
  42 If you want to **contribute** to rust-analyzer or just curious about how things work
  43 under the hood, check the [./docs/dev](./docs/dev) folder.
  44
  45 If you want to **use** rust-analyzer's language server with your editor of
  46 choice, check [./docs/user](./docs/user) folder. It also contains some tips & tricks to help
  47 you be more productive when using rust-analyzer.
  48
  49 ## Getting in touch
  50
  51 We are on the rust-lang Zulip!
  52
  53 https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frls-2.2E0
  54
  55 ## Quick Links
  56
  57 * Work List: https://paper.dropbox.com/doc/RLS-2.0-work-list--AZ3BgHKKCtqszbsi3gi6sjchAQ-42vbnxzuKq2lKwW0mkn8Y
  58 * API docs: https://rust-analyzer.github.io/rust-analyzer/ra_ide_api/index.html
  59 * CI: https://travis-ci.org/rust-analyzer/rust-analyzer
  60
  61 ## License
  62
  63 Rust analyzer is primarily distributed under the terms of both the MIT
  64 license and the Apache License (Version 2.0).
  65
  66 See LICENSE-APACHE and LICENSE-MIT for details.