diff options
| author | bors[bot] <bors[bot]@users.noreply.github.com> | 2019-05-11 12:23:14 +0100 |
|---|---|---|
| committer | bors[bot] <bors[bot]@users.noreply.github.com> | 2019-05-11 12:23:14 +0100 |
| commit | f7f64cf24e10b214fa87b107b7a7a4cf4a0d5d06 (patch) | |
| tree | a624b85e445abd0cb367f175478725a6c6e76414 | |
| parent | 6ceaea9e9505cfa07c0a76b590b62fa9615061cd (diff) | |
| parent | 2c0f4172e4f1e8000d4cbb1f2c73ff98f792ac40 (diff) | |
Merge #1261
1261: add manual installation instructions r=matklad a=matklad
Co-authored-by: Aleksey Kladov <[email protected]>
| -rw-r--r-- | docs/user/README.md | 25 |
1 files changed, 17 insertions, 8 deletions
diff --git a/docs/user/README.md b/docs/user/README.md index 0196bf45f..1b4d13d0f 100644 --- a/docs/user/README.md +++ b/docs/user/README.md | |||
| @@ -36,12 +36,21 @@ $ cd rust-analyzer | |||
| 36 | $ cargo install-code | 36 | $ cargo install-code |
| 37 | ``` | 37 | ``` |
| 38 | 38 | ||
| 39 | This will run `cargo install --package ra_lsp_server` to install the server | 39 | The automatic installation is expected to *just work* for common cases, if it |
| 40 | binary into `~/.cargo/bin`, and then will build and install plugin from | 40 | doesn't, report bugs! |
| 41 | `editors/code`. See | 41 | |
| 42 | [this](https://github.com/rust-analyzer/rust-analyzer/blob/69ee5c9c5ef212f7911028c9ddf581559e6565c3/crates/tools/src/main.rs#L37-L56) | 42 | If you have an usual setup (for example, `code` is not in the `PATH`), you |
| 43 | for details. The installation is expected to *just work*, if it doesn't, report | 43 | should adapt these manual installation instructions: |
| 44 | bugs! | 44 | |
| 45 | ``` | ||
| 46 | $ git clone https://github.com/rust-analyzer/rust-analyzer.git --depth 1 | ||
| 47 | $ cd rust-analyzer | ||
| 48 | $ cargo install --path ./crates/ra_lsp_server/ --force | ||
| 49 | $ cd ./editors/code | ||
| 50 | $ npm install | ||
| 51 | $ ./node_modules/vsce/out/vsce package | ||
| 52 | $ code --install-extension ./ra-lsp-0.0.1.vsix | ||
| 53 | ``` | ||
| 45 | 54 | ||
| 46 | It's better to remove existing Rust plugins to avoid interference. | 55 | It's better to remove existing Rust plugins to avoid interference. |
| 47 | 56 | ||
| @@ -59,8 +68,8 @@ for details. | |||
| 59 | * `rust-analyzer.raLspServerPath`: path to `ra_lsp_server` executable | 68 | * `rust-analyzer.raLspServerPath`: path to `ra_lsp_server` executable |
| 60 | * `rust-analyzer.enableCargoWatchOnStartup`: prompt to install & enable `cargo | 69 | * `rust-analyzer.enableCargoWatchOnStartup`: prompt to install & enable `cargo |
| 61 | watch` for live error highlighting (note, this **does not** use rust-analyzer) | 70 | watch` for live error highlighting (note, this **does not** use rust-analyzer) |
| 62 | * `rust-analyzer.cargo-watch.check-arguments`: cargo-watch check arguments. | 71 | * `rust-analyzer.cargo-watch.check-arguments`: cargo-watch check arguments. |
| 63 | (e.g: `--features="shumway,pdf"` will run as `cargo watch -x "check --features="shumway,pdf""` ) | 72 | (e.g: `--features="shumway,pdf"` will run as `cargo watch -x "check --features="shumway,pdf""` ) |
| 64 | * `rust-analyzer.trace.server`: enables internal logging | 73 | * `rust-analyzer.trace.server`: enables internal logging |
| 65 | * `rust-analyzer.trace.cargo-watch`: enables cargo-watch logging | 74 | * `rust-analyzer.trace.cargo-watch`: enables cargo-watch logging |
| 66 | 75 | ||