diff options
-rw-r--r-- | docs/user/README.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/docs/user/README.md b/docs/user/README.md index f45c0d7d1..f1628d6a4 100644 --- a/docs/user/README.md +++ b/docs/user/README.md | |||
@@ -61,6 +61,25 @@ for details. | |||
61 | For updates, pull the latest changes from the master branch, run `cargo xtask install` again, and **restart** VS Code instance. | 61 | For updates, pull the latest changes from the master branch, run `cargo xtask install` again, and **restart** VS Code instance. |
62 | See [microsoft/vscode#72308](https://github.com/microsoft/vscode/issues/72308) for why a full restart is needed. | 62 | See [microsoft/vscode#72308](https://github.com/microsoft/vscode/issues/72308) for why a full restart is needed. |
63 | 63 | ||
64 | ### VS Code Remote | ||
65 | |||
66 | You can also use `rust-analyzer` with the Visual Studio Code Remote extensions | ||
67 | (Remote SSH, Remote WSL, Remote Containers). In this case, however, you have to | ||
68 | manually install the `.vsix` package: | ||
69 | |||
70 | 1. Build the extension on the remote host using the instructions above (ignore the | ||
71 | error if `code` cannot be found in your PATH: VSCode doesn't need to be installed | ||
72 | on the remote host). | ||
73 | 2. In Visual Studio Code open a connection to the remote host. | ||
74 | 3. Open the Extensions View (`View > Extensions`, keyboard shortcut: `Ctrl+Shift+X`). | ||
75 | 4. From the top-right kebab menu (`ยทยทยท`) select `Install from VSIX...` | ||
76 | 5. Inside the `rust-analyzer` directory find the `editors/code` subdirectory and choose | ||
77 | the `ra-lsp-0.0.1.vsix` file. | ||
78 | 6. Restart Visual Studio Code and re-establish the connection to the remote host. | ||
79 | |||
80 | In case of errors please make sure that `~/.cargo/bin` is in your `PATH` on the remote | ||
81 | host. | ||
82 | |||
64 | ### Settings | 83 | ### Settings |
65 | 84 | ||
66 | * `rust-analyzer.highlightingOn`: enables experimental syntax highlighting | 85 | * `rust-analyzer.highlightingOn`: enables experimental syntax highlighting |