Skip to content

Commit 6a36788

Browse files
author
Veetaha
committed
vscode: updated docs on prebuilt binaries
1 parent 7cba77e commit 6a36788

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

docs/user/README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,37 @@ a minimum version of 10 installed. Please refer to
3232
You will also need the most recent version of VS Code: we don't try to
3333
maintain compatibility with older versions yet.
3434

35+
### Installation from prebuilt binaries
36+
37+
We ship prebuilt binaries for Linux, Mac and Windows via
38+
[GitHub releases](https://github.com/rust-analyzer/rust-analyzer/releases).
39+
In order to use them you need to install the client VSCode extension.
40+
41+
Publishing to VSCode marketplace is currently WIP. Thus you need to clone the repository and install **only** the client extension via
42+
```
43+
$ git clone https://github.com/rust-analyzer/rust-analyzer.git --depth 1
44+
$ cd rust-analyzer
45+
$ cargo xtask install --client-code
46+
```
47+
Then open VSCode (or reload the window if it was already running), open some Rust project and you should
48+
see an info message pop-up.
49+
50+
51+
<img height="140px" src="https://user-images.githubusercontent.com/36276403/74103174-a40df100-4b52-11ea-81f4-372c70797924.png" alt="Download now message"/>
52+
53+
54+
Click `Download now`, wait untill the progress is 100% and you are ready to go.
55+
56+
For updates you need to remove installed binary
57+
```
58+
rm -rf ${HOME}/.config/Code/User/globalStorage/matklad.rust-analyzer
59+
```
60+
61+
`"Donwload latest language server"` command for VSCode and automatic updates detection is currently WIP.
62+
63+
64+
### Installation from sources
65+
3566
The experimental VS Code plugin can then be built and installed by executing the
3667
following commands:
3768

@@ -47,6 +78,7 @@ doesn't, report bugs!
4778
**Note** [#1831](https://github.com/rust-analyzer/rust-analyzer/issues/1831): If you are using the popular
4879
[Vim emulation plugin](https://github.com/VSCodeVim/Vim), you will likely
4980
need to turn off the `rust-analyzer.enableEnhancedTyping` setting.
81+
(// 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))
5082

5183
If you have an unusual setup (for example, `code` is not in the `PATH`), you
5284
should adapt these manual installation instructions:

0 commit comments

Comments
 (0)