diff options
Diffstat (limited to 'editors')
-rw-r--r-- | editors/code/README.md | 39 |
1 files changed, 38 insertions, 1 deletions
diff --git a/editors/code/README.md b/editors/code/README.md index e7d7a06f0..67df34f7e 100644 --- a/editors/code/README.md +++ b/editors/code/README.md | |||
@@ -2,8 +2,22 @@ | |||
2 | 2 | ||
3 | Provides support for rust-analyzer: novel LSP server for the Rust programming language. | 3 | Provides support for rust-analyzer: novel LSP server for the Rust programming language. |
4 | 4 | ||
5 | **Note** the extension may cause conflicts with the official Rust extension. It is recommended to disable the Rust extension when using the rust-analyzer extension. | ||
5 | 6 | ||
6 | Features: | 7 | **Note** the project is in alpha status: it is already useful in practice, but can't be considered stable. |
8 | |||
9 | ## Sponsor | ||
10 | |||
11 | Work on rust-analyzer is sponsored by | ||
12 | |||
13 | [<img src="https://user-images.githubusercontent.com/1711539/58105231-cf306900-7bee-11e9-83d8-9f1102e59d29.png" alt="Ferrous Systems" width="300">](https://ferrous-systems.com/) | ||
14 | - [Mozilla](https://www.mozilla.org/en-US/) | ||
15 | - [Embark Studios](https://embark-studios.com/) | ||
16 | - [freiheit.com](https://www.freiheit.com) | ||
17 | |||
18 | |||
19 | |||
20 | ## Features | ||
7 | 21 | ||
8 | * [code completion], [imports insertion] | 22 | * [code completion], [imports insertion] |
9 | * [go to definition], [implementation], [type definition] | 23 | * [go to definition], [implementation], [type definition] |
@@ -28,6 +42,29 @@ Features: | |||
28 | [semantic syntax highlighting]: https://rust-analyzer.github.io/manual.html#semantic-syntax-highlighting | 42 | [semantic syntax highlighting]: https://rust-analyzer.github.io/manual.html#semantic-syntax-highlighting |
29 | [assist(code actions)]: https://rust-analyzer.github.io/manual.html#assists-code-actions | 43 | [assist(code actions)]: https://rust-analyzer.github.io/manual.html#assists-code-actions |
30 | 44 | ||
45 | |||
46 | |||
31 | [manual]: https://rust-analyzer.github.io/manual.html | 47 | [manual]: https://rust-analyzer.github.io/manual.html |
32 | 48 | ||
49 | ## Quick start | ||
50 | 1. Install [rustup] the rust toolchain | ||
51 | 2. Install the [rust-analyzer extension] | ||
52 | |||
53 | [rustup]: https://rustup.rs | ||
54 | [rust-analyzer extension]: https://marketplace.visualstudio.com/items?itemName=matklad.rust-analyzer | ||
55 | |||
56 | ## Configuration | ||
57 | |||
58 | This extension provides configurations through VSCode's configuration settings. All the configurations are under `rust-analyzer.*`. | ||
59 | |||
60 | See https://rust-analyzer.github.io/manual.html#vs-code-2 for more information on VSCode specific configurations. | ||
61 | |||
62 | ## Communication | ||
63 | |||
64 | For usage and troubleshooting requests, please use "IDEs and Editors" category of the Rust forum: | ||
65 | |||
66 | https://users.rust-lang.org/c/ide/14 | ||
67 | |||
68 | ## Documentation | ||
69 | |||
33 | See https://rust-analyzer.github.io/ for more information. | 70 | See https://rust-analyzer.github.io/ for more information. |