diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/user/README.md | 27 | ||||
-rw-r--r-- | docs/user/features.md | 8 |
2 files changed, 35 insertions, 0 deletions
diff --git a/docs/user/README.md b/docs/user/README.md index 33dd4f995..0196bf45f 100644 --- a/docs/user/README.md +++ b/docs/user/README.md | |||
@@ -78,3 +78,30 @@ Installation: | |||
78 | to load path and require it in `init.el` | 78 | to load path and require it in `init.el` |
79 | * run `lsp` in a rust buffer | 79 | * run `lsp` in a rust buffer |
80 | * (Optionally) bind commands like `rust-analyzer-join-lines` or `rust-analyzer-extend-selection` to keys | 80 | * (Optionally) bind commands like `rust-analyzer-join-lines` or `rust-analyzer-extend-selection` to keys |
81 | |||
82 | |||
83 | ## Sublime Text 3 | ||
84 | |||
85 | Prequisites: | ||
86 | |||
87 | `LSP` package. | ||
88 | |||
89 | Installation: | ||
90 | |||
91 | * Invoke the command palette with <kbd>Ctrl+Shift+P</kbd> | ||
92 | * Type `LSP Settings` to open the LSP preferences editor | ||
93 | * Add the following LSP client definition to your settings: | ||
94 | |||
95 | ```json | ||
96 | "rust-analyzer": { | ||
97 | "command": ["rustup", "run", "stable", "ra_lsp_server"], | ||
98 | "languageId": "rust", | ||
99 | "scopes": ["source.rust"], | ||
100 | "syntaxes": [ | ||
101 | "Packages/Rust/Rust.sublime-syntax", | ||
102 | "Packages/Rust Enhanced/RustEnhanced.sublime-syntax" | ||
103 | ] | ||
104 | } | ||
105 | ``` | ||
106 | |||
107 | * You can now invoke the command palette and type LSP enable to locally/globally enable the rust-analyzer LSP (type LSP enable, then choose either locally or globally, then select rust-analyzer) | ||
diff --git a/docs/user/features.md b/docs/user/features.md index 09a7f5a43..cffbb4c7f 100644 --- a/docs/user/features.md +++ b/docs/user/features.md | |||
@@ -76,6 +76,14 @@ Shows internal statistic about memory usage of rust-analyzer | |||
76 | 76 | ||
77 | Manually triggers GC | 77 | Manually triggers GC |
78 | 78 | ||
79 | #### Start Cargo Watch | ||
80 | |||
81 | Start `cargo watch` for live error highlighting. Will prompt to install if it's not already installed. | ||
82 | |||
83 | #### Stop Cargo Watch | ||
84 | |||
85 | Stop `cargo watch` | ||
86 | |||
79 | ### Code Actions (Assists) | 87 | ### Code Actions (Assists) |
80 | 88 | ||
81 | These are triggered in a particular context via light bulb. We use custom code on | 89 | These are triggered in a particular context via light bulb. We use custom code on |