Mirrors/rust-analyzer
2
0
Fork 0
mirror of https://github.com/rust-lang/rust-analyzer synced 2024-12-26 13:03:31 +00:00
Code Issues Projects Releases Packages Wiki Activity

Clarify installation instructions

Browse source 
In particular it is necessary to clone the repository before running the other commands. I also removed the `cargo install` side note because it didn't actually work (running the command just produces an error that --package isn't a recognized flag) and added a tldr code block with the list of commands to run.
This commit is contained in:
Jonathan Behrens 2019-11-30 21:20:54 -05:00 committed by GitHub
parent 780f476b4f
commit c69ed9bd1f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
docs/user/README.md
View file

@ -1,14 +1,19 @@
The main interface to rust-analyzer is the
[LSP](https://microsoft.github.io/language-server-protocol/) implementation. To
install lsp server, use `cargo xtask install --server`, which is a shorthand for `cargo
install --package ra_lsp_server`. The binary is named `ra_lsp_server`, you
should be able to use it with any LSP-compatible editor. We use custom
extensions to LSP, so special client-side support is required to take full
advantage of rust-analyzer. This repository contains support code for VS Code
and Emacs.
[LSP](https://microsoft.github.io/language-server-protocol/)
implementation. To install lsp server, clone the repository and
then run `cargo xtask install --server`. This will produce a
binary named `ra_lsp_server` which you should be able to use it
with any LSP-compatible editor. We use custom extensions to LSP,
so special client-side support is required to take full advantage
of rust-analyzer. This repository contains support code for VS
Code and Emacs.
Rust Analyzer needs sources of rust standard library to work, so you might need
to execute
```
$ git clone git@github.com:rust-analyzer/rust-analyzer && cd rust-analyzer
$ cargo xtask install --server
```
Rust Analyzer needs sources of rust standard library to work, so
you might also need to execute
```
$ rustup component add rust-src