diff --git a/docs/user/README.md b/docs/user/README.md index 18867cd11a..abf7c013b3 100644 --- a/docs/user/README.md +++ b/docs/user/README.md @@ -32,6 +32,37 @@ a minimum version of 10 installed. Please refer to You will also need the most recent version of VS Code: we don't try to maintain compatibility with older versions yet. +### Installation from prebuilt binaries + +We ship prebuilt binaries for Linux, Mac and Windows via +[GitHub releases](https://github.com/rust-analyzer/rust-analyzer/releases). +In order to use them you need to install the client VSCode extension. + +Publishing to VSCode marketplace is currently WIP. Thus you need to clone the repository and install **only** the client extension via +``` +$ git clone https://github.com/rust-analyzer/rust-analyzer.git --depth 1 +$ cd rust-analyzer +$ cargo xtask install --client-code +``` +Then open VSCode (or reload the window if it was already running), open some Rust project and you should +see an info message pop-up. + + +Download now message + + +Click `Download now`, wait untill the progress is 100% and you are ready to go. + +For updates you need to remove installed binary +``` +rm -rf ${HOME}/.config/Code/User/globalStorage/matklad.rust-analyzer +``` + +`"Donwload latest language server"` command for VSCode and automatic updates detection is currently WIP. + + +### Installation from sources + The experimental VS Code plugin can then be built and installed by executing the following commands: @@ -47,6 +78,7 @@ doesn't, report bugs! **Note** [#1831](https://github.com/rust-analyzer/rust-analyzer/issues/1831): If you are using the popular [Vim emulation plugin](https://github.com/VSCodeVim/Vim), you will likely need to turn off the `rust-analyzer.enableEnhancedTyping` setting. +(// 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)) If you have an unusual setup (for example, `code` is not in the `PATH`), you should adapt these manual installation instructions: