aboutsummaryrefslogtreecommitdiff
path: root/docs/user/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/user/README.md')
-rw-r--r--docs/user/README.md18
1 files changed, 6 insertions, 12 deletions
diff --git a/docs/user/README.md b/docs/user/README.md
index 082dadd76..3da30a193 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
6you should be able to use it with any LSP-compatible editor. We use custom 6you should be able to use it with any LSP-compatible editor. We use custom
7extensions to LSP, so special client-side support is required to take full 7extensions to LSP, so special client-side support is required to take full
8advantage of rust-analyzer. This repository contains support code for VS Code 8advantage of rust-analyzer. This repository contains support code for VS Code.
9and 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
@@ -162,17 +161,12 @@ host.
162 161
163## Emacs 162## Emacs
164 163
165Prerequisites: 164* install recent version of `emacs-lsp` package by following the instructions [here][emacs-lsp]
166 165* set `lsp-rust-server` to `'rust-analyzer`
167`emacs-lsp`, `dash` and `ht` packages. 166* run `lsp` in a Rust buffer
168 167* (Optionally) bind commands like `lsp-rust-analyzer-join-lines`, `lsp-extend-selection` and `lsp-rust-analyzer-expand-macro` to keys
169Installation:
170 168
171* add 169[emacs-lsp]: https://github.com/emacs-lsp/lsp-mode
172[rust-analyzer.el](../../editors/emacs/rust-analyzer.el)
173to load path and require it in `init.el`
174* run `lsp` in a rust buffer
175* (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
176 170
177 171
178## Vim and NeoVim (coc-rust-analyzer) 172## Vim and NeoVim (coc-rust-analyzer)