aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/user/readme.adoc21
1 files changed, 19 insertions, 2 deletions
diff --git a/docs/user/readme.adoc b/docs/user/readme.adoc
index f1386a8f9..4e99dd0a6 100644
--- a/docs/user/readme.adoc
+++ b/docs/user/readme.adoc
@@ -2,6 +2,13 @@
2:toc: preamble 2:toc: preamble
3:sectanchors: 3:sectanchors:
4:page-layout: post 4:page-layout: post
5// https://gist.github.com/dcode/0cfbf2699a1fe9b46ff04c41721dda74#admonitions
6:tip-caption: :bulb:
7:note-caption: :information_source:
8:important-caption: :heavy_exclamation_mark:
9:caution-caption: :fire:
10:warning-caption: :warning:
11
5 12
6 13
7// Master copy of this document lives in the https://github.com/rust-analyzer/rust-analyzer repository 14// Master copy of this document lives in the https://github.com/rust-analyzer/rust-analyzer repository
@@ -30,7 +37,7 @@ $ rustup component add rust-src
30 37
31=== VS Code 38=== VS Code
32 39
33This the best supported editor at the moment. 40This is the best supported editor at the moment.
34rust-analyzer plugin for VS Code is maintained 41rust-analyzer plugin for VS Code is maintained
35https://github.com/rust-analyzer/rust-analyzer/tree/master/editors/code[in tree]. 42https://github.com/rust-analyzer/rust-analyzer/tree/master/editors/code[in tree].
36 43
@@ -40,6 +47,16 @@ By default, the plugin will prompt you to download the matching version of the s
40 47
41image::https://user-images.githubusercontent.com/9021944/75067008-17502500-54ba-11ea-835a-f92aac50e866.png[] 48image::https://user-images.githubusercontent.com/9021944/75067008-17502500-54ba-11ea-835a-f92aac50e866.png[]
42 49
50[NOTE]
51====
52To disable this notification put the following to `settings.json`
53
54[source,json]
55----
56{ "rust-analyzer.updates.askBeforeDownload": false }
57----
58====
59
43The server binary is stored in `~/.config/Code/User/globalStorage/matklad.rust-analyzer`. 60The server binary is stored in `~/.config/Code/User/globalStorage/matklad.rust-analyzer`.
44 61
45Note that we only support the latest version of VS Code. 62Note that we only support the latest version of VS Code.
@@ -124,7 +141,7 @@ let g:LanguageClient_serverCommands = {
124 141
125NeoVim 0.5 (not yet released) has built-in language server support. 142NeoVim 0.5 (not yet released) has built-in language server support.
126For a quick start configuration of rust-analyzer, use https://github.com/neovim/nvim-lsp#rust_analyzer[neovim/nvim-lsp]. 143For a quick start configuration of rust-analyzer, use https://github.com/neovim/nvim-lsp#rust_analyzer[neovim/nvim-lsp].
127Once `neovim/nvim-lsp` is installed, use `lua require'nvim_lsp'.rust_analyzer.setup({})` in your `init.vim`. 144Once `neovim/nvim-lsp` is installed, use `+lua require'nvim_lsp'.rust_analyzer.setup({})+` in your `init.vim`.
128 145
129=== Sublime Text 3 146=== Sublime Text 3
130 147