rust/README.md

67 lines
2.4 KiB
Markdown
Raw Normal View History

2018-09-16 06:29:34 -05:00
# Rust Analyzer
2018-01-10 12:58:38 -06:00
2018-10-09 08:18:22 -05:00
[![Build Status](https://travis-ci.org/rust-analyzer/rust-analyzer.svg?branch=master)](https://travis-ci.org/rust-analyzer/rust-analyzer)
2018-01-27 18:15:30 -06:00
2019-01-13 04:51:26 -06:00
Rust Analyzer is an **experimental** modular compiler frontend for the Rust
2019-02-12 08:55:02 -06:00
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:
2018-01-10 13:49:22 -06:00
https://github.com/rust-lang/compiler-team/tree/master/working-groups/rls-2.0
2018-01-10 12:58:38 -06:00
2018-10-22 07:59:01 -05:00
Work on the Rust Analyzer is sponsored by
2019-05-21 09:10:08 -05: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/)
2019-05-21 05:27:07 -05:00
- [Mozilla](https://www.mozilla.org/en-US/)
2018-10-22 07:59:01 -05:00
2019-03-20 02:00:54 -05:00
## Language Server Quick Start
2018-08-24 10:14:21 -05:00
2019-03-20 02:00:54 -05: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.
2018-09-16 07:36:09 -05:00
2019-03-20 02:00:54 -05:00
To build rust-analyzer, you need:
2018-08-24 10:14:21 -05:00
2019-03-20 02:00:54 -05:00
* latest stable rust for language server itself
* latest stable npm and VS Code for VS Code extension (`code` should be in path)
2018-08-24 10:14:21 -05:00
For setup for other editors, see [./docs/user](./docs/user).
2018-08-24 10:14:21 -05:00
2019-01-13 04:51:26 -06:00
```
2019-03-20 02:00:54 -05:00
# clone the repo
$ git clone https://github.com/rust-analyzer/rust-analyzer && cd rust-analyzer
2018-09-08 11:23:52 -05:00
2019-03-20 02:00:54 -05: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
2018-08-24 10:14:21 -05:00
2019-03-20 02:00:54 -05:00
If you want to **contribute** to rust-analyzer or just curious about how things work
2019-03-20 04:21:55 -05:00
under the hood, check the [./docs/dev](./docs/dev) folder.
2019-03-20 02:00:54 -05:00
If you want to **use** rust-analyzer's language server with your editor of
2019-03-20 04:24:12 -05:00
choice, check [./docs/user](./docs/user) folder. It also contains some tips & tricks to help
2019-03-20 02:00:54 -05:00
you be more productive when using rust-analyzer.
2019-02-12 08:55:02 -06:00
## Getting in touch
2018-09-16 06:29:34 -05:00
2019-02-12 08:55:02 -06:00
We are on the rust-lang Zulip!
2018-09-16 06:29:34 -05:00
2019-02-12 08:55:02 -06:00
https://rust-lang.zulipchat.com/#narrow/stream/185405-t-compiler.2Frls-2.2E0
2018-10-09 13:30:41 -05:00
2019-03-26 07:38:46 -05: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
2018-01-10 13:47:04 -06:00
## License
2018-09-16 07:36:09 -05:00
Rust analyzer is primarily distributed under the terms of both the MIT
license and the Apache License (Version 2.0).
2018-01-10 13:47:04 -06:00
See LICENSE-APACHE and LICENSE-MIT for details.