From 6a367886ece53e12d62394fe676c9476b4343933 Mon Sep 17 00:00:00 2001 From: Veetaha Date: Sun, 9 Feb 2020 15:51:28 +0200 Subject: vscode: updated docs on prebuilt binaries --- docs/user/README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) (limited to 'docs/user/README.md') diff --git a/docs/user/README.md b/docs/user/README.md index 18867cd11..abf7c013b 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: -- cgit v1.2.3 From be244ab2fb243e945c7024da06c801fb3774b753 Mon Sep 17 00:00:00 2001 From: Veetaha Date: Sun, 9 Feb 2020 15:54:54 +0200 Subject: docs: minor fixes in wordings and punctuation --- docs/user/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/user/README.md') diff --git a/docs/user/README.md b/docs/user/README.md index abf7c013b..a60990ca8 100644 --- a/docs/user/README.md +++ b/docs/user/README.md @@ -38,7 +38,7 @@ 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 +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 @@ -63,7 +63,7 @@ rm -rf ${HOME}/.config/Code/User/globalStorage/matklad.rust-analyzer ### Installation from sources -The experimental VS Code plugin can then be built and installed by executing the +The experimental VS Code plugin can be built and installed by executing the following commands: ``` -- cgit v1.2.3 From dfb81a8cd4b9a2efd8151b4ac36105c51df7d683 Mon Sep 17 00:00:00 2001 From: Veetaha Date: Sun, 9 Feb 2020 17:04:33 +0200 Subject: docs: fix spelling untill -> until Co-Authored-By: Jonas Platte --- docs/user/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/user/README.md') diff --git a/docs/user/README.md b/docs/user/README.md index a60990ca8..082dadd76 100644 --- a/docs/user/README.md +++ b/docs/user/README.md @@ -51,7 +51,7 @@ see an info message pop-up. Download now message -Click `Download now`, wait untill the progress is 100% and you are ready to go. +Click `Download now`, wait until the progress is 100% and you are ready to go. For updates you need to remove installed binary ``` -- cgit v1.2.3