aboutsummaryrefslogtreecommitdiff
path: root/docs/user
diff options
context:
space:
mode:
Diffstat (limited to 'docs/user')
-rw-r--r--docs/user/readme.adoc14
1 files changed, 10 insertions, 4 deletions
diff --git a/docs/user/readme.adoc b/docs/user/readme.adoc
index 867aae975..57a8cbe31 100644
--- a/docs/user/readme.adoc
+++ b/docs/user/readme.adoc
@@ -19,6 +19,13 @@ https://github.com/rust-analyzer/rust-analyzer/blob/master/docs/user/readme.adoc
19In theory, one should be able to just install the server binary and have it automatically work with any editor. 19In theory, one should be able to just install the server binary and have it automatically work with any editor.
20We are not there yet, so some editor specific setup is required. 20We are not there yet, so some editor specific setup is required.
21 21
22Additionally, rust-analyzer needs sources of the standard library.
23This commands adds them:
24
25```bash
26$ rustup component add rust-src
27```
28
22=== VS Code 29=== VS Code
23 30
24This the best supported editor at the moment. 31This the best supported editor at the moment.
@@ -27,8 +34,9 @@ https://github.com/rust-analyzer/rust-analyzer/tree/master/editors/code[in tree]
27 34
28You can install the latest release of the plugin from 35You can install the latest release of the plugin from
29https://marketplace.visualstudio.com/items?itemName=matklad.rust-analyzer[the marketplace]. 36https://marketplace.visualstudio.com/items?itemName=matklad.rust-analyzer[the marketplace].
30By default, the plugin will download the latest version of the server as well. 37By default, the plugin will download the matching version of the server as well.
31 38
39// FIXME: update the image (its text has changed)
32image::https://user-images.githubusercontent.com/36276403/74103174-a40df100-4b52-11ea-81f4-372c70797924.png[] 40image::https://user-images.githubusercontent.com/36276403/74103174-a40df100-4b52-11ea-81f4-372c70797924.png[]
33 41
34The server binary is stored in `~/.config/Code/User/globalStorage/matklad.rust-analyzer`. 42The server binary is stored in `~/.config/Code/User/globalStorage/matklad.rust-analyzer`.
@@ -37,9 +45,7 @@ Note that we only support the latest version of VS Code.
37 45
38==== Updates 46==== Updates
39 47
40The extension will be updated automatically as new versions become available. 48The extension will be updated automatically as new versions become available. It will ask your permission to download the matching language server version binary if needed.
41The server update functionality is in progress.
42For the time being, the workaround is to remove the binary from `globalStorage` and to restart the extension.
43 49
44==== Building From Source 50==== Building From Source
45 51