rust-analyzer/README.md

# Rust Analyzer

[![Build Status](https://travis-ci.org/rust-analyzer/rust-analyzer.svg?branch=master)](https://travis-ci.org/rust-analyzer/rust-analyzer)

Rust Analyzer is an **experimental** modular compiler frontend for the Rust
language. It is a part of a larger rls-2.0 effort to create excellent IDE
support for Rust. If you want to get involved, check the rls-2.0 working group
in the compiler-team repository:

https://github.com/rust-lang/compiler-team/tree/master/working-groups/rls-2.0

Work on the Rust Analyzer is sponsored by

[<img src="https://user-images.githubusercontent.com/1711539/58105231-cf306900-7bee-11e9-83d8-9f1102e59d29.png" alt="Ferrous Systems" width="300">](https://ferrous-systems.com/)
- [Mozilla](https://www.mozilla.org/en-US/)

## Language Server Quick Start

Rust Analyzer is a work-in-progress, so you'll have to build it from source, and
you might encounter critical bugs. That said, it is complete enough to provide a
useful IDE experience and some people use it as a daily driver.

To build rust-analyzer, you need:

* latest stable rust for language server itself
* latest stable npm and VS Code for VS Code extension (`code` should be in path)

For setup for other editors, see [./docs/user](./docs/user).

```
# clone the repo
$ git clone https://github.com/rust-analyzer/rust-analyzer && cd rust-analyzer

# install both the language server and VS Code extension
$ cargo install-code

# alternatively, install only the server. Binary name is `ra_lsp_server`.
$ cargo install-lsp
```
## Documentation

If you want to **contribute** to rust-analyzer or just curious about how things work
under the hood, check the [./docs/dev](./docs/dev) folder.

If you want to **use** rust-analyzer's language server with your editor of
choice, check [./docs/user](./docs/user) folder. It also contains some tips & tricks to help
you be more productive when using rust-analyzer.

## Getting in touch

We are on the rust-lang Zulip!

https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frls-2.2E0

## Quick Links

* Work List: https://paper.dropbox.com/doc/RLS-2.0-work-list--AZ3BgHKKCtqszbsi3gi6sjchAQ-42vbnxzuKq2lKwW0mkn8Y
* API docs: https://rust-analyzer.github.io/rust-analyzer/ra_ide_api/index.html
* CI: https://travis-ci.org/rust-analyzer/rust-analyzer

## License

Rust analyzer is primarily distributed under the terms of both the MIT
license and the Apache License (Version 2.0).

See LICENSE-APACHE and LICENSE-MIT for details.
Update readme 2018-09-16 11:29:34 +00:00			`# Rust Analyzer`
D: start documenting stuff 2018-01-10 18:58:38 +00:00
fix readme 2018-10-09 13:18:22 +00:00			`[![Build Status](https://travis-ci.org/rust-analyzer/rust-analyzer.svg?branch=master)](https://travis-ci.org/rust-analyzer/rust-analyzer)`
Add appveyor badge 2018-01-28 00:15:30 +00:00
tweak readme 2019-01-13 10:51:26 +00:00			`Rust Analyzer is an experimental modular compiler frontend for the Rust`
update readme to point to the WG 2019-02-12 14:55:02 +00:00			`language. It is a part of a larger rls-2.0 effort to create excellent IDE`
Point to the compiler-team repo directly 2019-03-13 18:36:26 +00:00			`support for Rust. If you want to get involved, check the rls-2.0 working group`
			`in the compiler-team repository:`
Add Gitter badge 2018-01-10 19:49:22 +00:00
Point to the compiler-team repo directly 2019-03-13 18:36:26 +00:00			`https://github.com/rust-lang/compiler-team/tree/master/working-groups/rls-2.0`
D: start documenting stuff 2018-01-10 18:58:38 +00:00
Add link to ferrous 2018-10-22 12:59:01 +00:00			`Work on the Rust Analyzer is sponsored by`

fix logo 2019-05-21 14:10:08 +00:00			`[<img src="https://user-images.githubusercontent.com/1711539/58105231-cf306900-7bee-11e9-83d8-9f1102e59d29.png" alt="Ferrous Systems" width="300">](https://ferrous-systems.com/)`
mozilla is sponsoring as well 2019-05-21 10:27:07 +00:00			`- [Mozilla](https://www.mozilla.org/en-US/)`
Add link to ferrous 2018-10-22 12:59:01 +00:00
README is short and up to the point 2019-03-20 07:00:54 +00:00			`## Language Server Quick Start`
README 2018-08-24 15:14:21 +00:00
README is short and up to the point 2019-03-20 07:00:54 +00:00			`Rust Analyzer is a work-in-progress, so you'll have to build it from source, and`
			`you might encounter critical bugs. That said, it is complete enough to provide a`
			`useful IDE experience and some people use it as a daily driver.`
tweak readme 2018-09-16 12:36:09 +00:00
README is short and up to the point 2019-03-20 07:00:54 +00:00			`To build rust-analyzer, you need:`
README 2018-08-24 15:14:21 +00:00
README is short and up to the point 2019-03-20 07:00:54 +00:00			`* latest stable rust for language server itself`
Update README.md Co-Authored-By: matklad <aleksey.kladov@gmail.com> 2019-03-20 14:39:56 +00:00			* latest stable npm and VS Code for VS Code extension (`code` should be in path)
README 2018-08-24 15:14:21 +00:00
sadly, we support only a single language atm 2019-03-20 09:25:03 +00:00			`For setup for other editors, see [./docs/user](./docs/user).`
README 2018-08-24 15:14:21 +00:00
tweak readme 2019-01-13 10:51:26 +00:00			```
README is short and up to the point 2019-03-20 07:00:54 +00:00			`# clone the repo`
			`$ git clone https://github.com/rust-analyzer/rust-analyzer && cd rust-analyzer`
note about symbol search 2018-09-08 16:23:52 +00:00
README is short and up to the point 2019-03-20 07:00:54 +00:00			`# install both the language server and VS Code extension`
			`$ cargo install-code`

			# alternatively, install only the server. Binary name is `ra_lsp_server`.
			`$ cargo install-lsp`
			```
			`## Documentation`
README 2018-08-24 15:14:21 +00:00
README is short and up to the point 2019-03-20 07:00:54 +00:00			`If you want to contribute to rust-analyzer or just curious about how things work`
fix links 2019-03-20 09:21:55 +00:00			`under the hood, check the [./docs/dev](./docs/dev) folder.`
Config for raLspServerPath will be overwritten if __RA_LSP_SERVER_DEBUG is set Changed presentation from clear to reveal silent Removed the vscode gitignore entry Added debugging documentation Added tasks and launch configs 2019-01-18 10:59:08 +00:00
README is short and up to the point 2019-03-20 07:00:54 +00:00			`If you want to use rust-analyzer's language server with your editor of`
fix links 2019-03-20 09:24:12 +00:00			`choice, check [./docs/user](./docs/user) folder. It also contains some tips & tricks to help`
README is short and up to the point 2019-03-20 07:00:54 +00:00			`you be more productive when using rust-analyzer.`
Config for raLspServerPath will be overwritten if __RA_LSP_SERVER_DEBUG is set Changed presentation from clear to reveal silent Removed the vscode gitignore entry Added debugging documentation Added tasks and launch configs 2019-01-18 10:59:08 +00:00
update readme to point to the WG 2019-02-12 14:55:02 +00:00			`## Getting in touch`
Update readme 2018-09-16 11:29:34 +00:00
update readme to point to the WG 2019-02-12 14:55:02 +00:00			`We are on the rust-lang Zulip!`
Update readme 2018-09-16 11:29:34 +00:00
update readme to point to the WG 2019-02-12 14:55:02 +00:00			`https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frls-2.2E0`
brush up docs 2018-10-09 18:30:41 +00:00
add links to readme 2019-03-26 12:38:46 +00:00			`## Quick Links`

			`* Work List: https://paper.dropbox.com/doc/RLS-2.0-work-list--AZ3BgHKKCtqszbsi3gi6sjchAQ-42vbnxzuKq2lKwW0mkn8Y`
			`* API docs: https://rust-analyzer.github.io/rust-analyzer/ra_ide_api/index.html`
			`* CI: https://travis-ci.org/rust-analyzer/rust-analyzer`

Licenses 2018-01-10 19:47:04 +00:00			`## License`

tweak readme 2018-09-16 12:36:09 +00:00			`Rust analyzer is primarily distributed under the terms of both the MIT`
			`license and the Apache License (Version 2.0).`
Licenses 2018-01-10 19:47:04 +00:00
			`See LICENSE-APACHE and LICENSE-MIT for details.`