diff options
| author | Florian Diebold <[email protected]> | 2020-02-08 15:02:37 +0000 |
|---|---|---|
| committer | Florian Diebold <[email protected]> | 2020-02-08 15:15:58 +0000 |
| commit | 134cc70097f2386bf3af6a15e3c29de9c317ed24 (patch) | |
| tree | c012a1fb7f7e97a34ff65559c15413a179a59e60 /docs/user/README.md | |
| parent | c27ec6908793e3b1706d683dc2c2d367ac8fc061 (diff) | |
Docs cleanups
Diffstat (limited to 'docs/user/README.md')
| -rw-r--r-- | docs/user/README.md | 18 |
1 files changed, 6 insertions, 12 deletions
diff --git a/docs/user/README.md b/docs/user/README.md index 18867cd11..da99a063c 100644 --- a/docs/user/README.md +++ b/docs/user/README.md | |||
| @@ -5,8 +5,7 @@ install lsp server, clone the repository and then run `cargo xtask install | |||
| 5 | ./crates/ra_lsp_server`). This will produce a binary named `ra_lsp_server` which | 5 | ./crates/ra_lsp_server`). This will produce a binary named `ra_lsp_server` which |
| 6 | you should be able to use it with any LSP-compatible editor. We use custom | 6 | you should be able to use it with any LSP-compatible editor. We use custom |
| 7 | extensions to LSP, so special client-side support is required to take full | 7 | extensions to LSP, so special client-side support is required to take full |
| 8 | advantage of rust-analyzer. This repository contains support code for VS Code | 8 | advantage of rust-analyzer. This repository contains support code for VS Code. |
| 9 | and Emacs. | ||
| 10 | 9 | ||
| 11 | ``` | 10 | ``` |
| 12 | $ git clone [email protected]:rust-analyzer/rust-analyzer && cd rust-analyzer | 11 | $ git clone [email protected]:rust-analyzer/rust-analyzer && cd rust-analyzer |
| @@ -130,17 +129,12 @@ host. | |||
| 130 | 129 | ||
| 131 | ## Emacs | 130 | ## Emacs |
| 132 | 131 | ||
| 133 | Prerequisites: | 132 | * install recent version of `emacs-lsp` package by following the instructions [here][emacs-lsp] |
| 134 | 133 | * set `lsp-rust-server` to `'rust-analyzer` | |
| 135 | `emacs-lsp`, `dash` and `ht` packages. | 134 | * run `lsp` in a Rust buffer |
| 136 | 135 | * (Optionally) bind commands like `lsp-rust-analyzer-join-lines`, `lsp-extend-selection` and `lsp-rust-analyzer-expand-macro` to keys | |
| 137 | Installation: | ||
| 138 | 136 | ||
| 139 | * add | 137 | [emacs-lsp]: https://github.com/emacs-lsp/lsp-mode |
| 140 | [rust-analyzer.el](../../editors/emacs/rust-analyzer.el) | ||
| 141 | to load path and require it in `init.el` | ||
| 142 | * run `lsp` in a rust buffer | ||
| 143 | * (Optionally) bind commands like `rust-analyzer-join-lines`, `rust-analyzer-extend-selection` and `rust-analyzer-expand-macro` to keys, and enable `rust-analyzer-inlay-hints-mode` to get inline type hints | ||
| 144 | 138 | ||
| 145 | 139 | ||
| 146 | ## Vim and NeoVim (coc-rust-analyzer) | 140 | ## Vim and NeoVim (coc-rust-analyzer) |