diff options
Diffstat (limited to 'docs/user')
-rw-r--r-- | docs/user/readme.adoc | 14 |
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 | |||
19 | In theory, one should be able to just install the server binary and have it automatically work with any editor. | 19 | In theory, one should be able to just install the server binary and have it automatically work with any editor. |
20 | We are not there yet, so some editor specific setup is required. | 20 | We are not there yet, so some editor specific setup is required. |
21 | 21 | ||
22 | Additionally, rust-analyzer needs sources of the standard library. | ||
23 | This commands adds them: | ||
24 | |||
25 | ```bash | ||
26 | $ rustup component add rust-src | ||
27 | ``` | ||
28 | |||
22 | === VS Code | 29 | === VS Code |
23 | 30 | ||
24 | This the best supported editor at the moment. | 31 | This 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 | ||
28 | You can install the latest release of the plugin from | 35 | You can install the latest release of the plugin from |
29 | https://marketplace.visualstudio.com/items?itemName=matklad.rust-analyzer[the marketplace]. | 36 | https://marketplace.visualstudio.com/items?itemName=matklad.rust-analyzer[the marketplace]. |
30 | By default, the plugin will download the latest version of the server as well. | 37 | By default, the plugin will download the matching version of the server as well. |
31 | 38 | ||
39 | // FIXME: update the image (its text has changed) | ||
32 | image::https://user-images.githubusercontent.com/36276403/74103174-a40df100-4b52-11ea-81f4-372c70797924.png[] | 40 | image::https://user-images.githubusercontent.com/36276403/74103174-a40df100-4b52-11ea-81f4-372c70797924.png[] |
33 | 41 | ||
34 | The server binary is stored in `~/.config/Code/User/globalStorage/matklad.rust-analyzer`. | 42 | The 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 | ||
40 | The extension will be updated automatically as new versions become available. | 48 | The 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. |
41 | The server update functionality is in progress. | ||
42 | For 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 | ||