mirror of
https://github.com/rust-lang/rust-analyzer
synced 2024-12-26 04:53:34 +00:00
Link proper docs from readme
This commit is contained in:
parent
fc4d0a7768
commit
c629ada820
1 changed files with 3 additions and 27 deletions
30
README.md
30
README.md
|
@ -14,33 +14,9 @@ Work on rust-analyzer is sponsored by
|
||||||
- [Mozilla](https://www.mozilla.org/en-US/)
|
- [Mozilla](https://www.mozilla.org/en-US/)
|
||||||
- [freiheit.com](https://www.freiheit.com)
|
- [freiheit.com](https://www.freiheit.com)
|
||||||
|
|
||||||
## Language Server Quick Start
|
## Quick Start
|
||||||
|
|
||||||
rust-analyzer is a work-in-progress, so you might encounter critical bugs. That
|
https://rust-analyzer.github.io/manual.html#installation
|
||||||
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 the language server itself
|
|
||||||
* latest stable npm and VS Code for VS Code extension
|
|
||||||
|
|
||||||
To quickly install the rust-analyzer language server and VS Code extension with
|
|
||||||
standard setup (`code` and `cargo` in `$PATH`, etc), use this:
|
|
||||||
|
|
||||||
```
|
|
||||||
# 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 xtask install
|
|
||||||
|
|
||||||
# alternatively, install only the server. Binary name is `rust-analyzer`.
|
|
||||||
$ cargo xtask install --server
|
|
||||||
```
|
|
||||||
|
|
||||||
For non-standard setup of VS Code and other editors, or if the language server
|
|
||||||
cannot start, see [./docs/user](./docs/user).
|
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
|
@ -48,7 +24,7 @@ If you want to **contribute** to rust-analyzer or are just curious about how
|
||||||
things work under the hood, check the [./docs/dev](./docs/dev) folder.
|
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
|
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
|
choice, check [the manual](https://rust-analyzer.github.io/manual.html) folder. It also contains some tips & tricks to help
|
||||||
you be more productive when using rust-analyzer.
|
you be more productive when using rust-analyzer.
|
||||||
|
|
||||||
## Getting in touch
|
## Getting in touch
|
||||||
|
|
Loading…
Reference in a new issue