itsscb/rust-analyzer
1
0
Fork 0
mirror of https://github.com/rust-lang/rust-analyzer.git synced 2025-11-03 13:13:18 +00:00
Code Issues Packages Projects Releases 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 The main interface to rust-analyzer is the
[LSP](https://microsoft.github.io/language-server-protocol/) implementation. To [LSP](https://microsoft.github.io/language-server-protocol/)
install lsp server, use `cargo xtask install --server`, which is a shorthand for `cargo implementation. To install lsp server, clone the repository and
install --package ra_lsp_server`. The binary is named `ra_lsp_server`, you then run `cargo xtask install --server`. This will produce a
should be able to use it with any LSP-compatible editor. We use custom binary named `ra_lsp_server` which you should be able to use it
extensions to LSP, so special client-side support is required to take full with any LSP-compatible editor. We use custom extensions to LSP,
advantage of rust-analyzer. This repository contains support code for VS Code so special client-side support is required to take full advantage
and Emacs. 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 $ rustup component add rust-src