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.md34
1 files changed, 33 insertions, 1 deletions
diff --git a/docs/user/README.md b/docs/user/README.md
index da99a063c..3da30a193 100644
--- a/docs/user/README.md
+++ b/docs/user/README.md
@@ -31,7 +31,38 @@ a minimum version of 10 installed. Please refer to
31You will also need the most recent version of VS Code: we don't try to 31You will also need the most recent version of VS Code: we don't try to
32maintain compatibility with older versions yet. 32maintain compatibility with older versions yet.
33 33
34The experimental VS Code plugin can then be built and installed by executing the 34### Installation from prebuilt binaries
35
36We ship prebuilt binaries for Linux, Mac and Windows via
37[GitHub releases](https://github.com/rust-analyzer/rust-analyzer/releases).
38In order to use them you need to install the client VSCode extension.
39
40Publishing to VSCode marketplace is currently WIP. Thus, you need to clone the repository and install **only** the client extension via
41```
42$ git clone https://github.com/rust-analyzer/rust-analyzer.git --depth 1
43$ cd rust-analyzer
44$ cargo xtask install --client-code
45```
46Then open VSCode (or reload the window if it was already running), open some Rust project and you should
47see an info message pop-up.
48
49
50<img height="140px" src="https://user-images.githubusercontent.com/36276403/74103174-a40df100-4b52-11ea-81f4-372c70797924.png" alt="Download now message"/>
51
52
53Click `Download now`, wait until the progress is 100% and you are ready to go.
54
55For updates you need to remove installed binary
56```
57rm -rf ${HOME}/.config/Code/User/globalStorage/matklad.rust-analyzer
58```
59
60`"Donwload latest language server"` command for VSCode and automatic updates detection is currently WIP.
61
62
63### Installation from sources
64
65The experimental VS Code plugin can be built and installed by executing the
35following commands: 66following commands:
36 67
37``` 68```
@@ -46,6 +77,7 @@ doesn't, report bugs!
46**Note** [#1831](https://github.com/rust-analyzer/rust-analyzer/issues/1831): If you are using the popular 77**Note** [#1831](https://github.com/rust-analyzer/rust-analyzer/issues/1831): If you are using the popular
47[Vim emulation plugin](https://github.com/VSCodeVim/Vim), you will likely 78[Vim emulation plugin](https://github.com/VSCodeVim/Vim), you will likely
48need to turn off the `rust-analyzer.enableEnhancedTyping` setting. 79need to turn off the `rust-analyzer.enableEnhancedTyping` setting.
80(// TODO: This configuration is no longer available, enhanced typing shoud be disabled via removing Enter key binding, [see this issue](https://github.com/rust-analyzer/rust-analyzer/issues/3051))
49 81
50If you have an unusual setup (for example, `code` is not in the `PATH`), you 82If you have an unusual setup (for example, `code` is not in the `PATH`), you
51should adapt these manual installation instructions: 83should adapt these manual installation instructions: