Skip to content

Commit a0de172

Browse files
authored
Add more information to VSCode extenstion README
A lot of these are duplicated from the documentation or main README. While it's unfortunate to have duplicated information, the current VSCode page is very barebones and doesn't offer much confidence. This updated README offers a few more links and follows a structure similar to the official rust extension and other popular vscode extensions. The additions are, as much as possible specific to the vscode extension and not rust-analyzer as a LSP. The note about not using the official extension is also right there at the top because that's a common issue people have when trying it out. I added the sponsor section since it's common in other extensions README, but I'm not sure if it's necessary
1 parent a6ee8e9 commit a0de172

File tree

1 file changed

+38
-1
lines changed

1 file changed

+38
-1
lines changed

editors/code/README.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,22 @@
22

33
Provides support for rust-analyzer: novel LSP server for the Rust programming language.
44

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.
56

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
721

822
* [code completion], [imports insertion]
923
* [go to definition], [implementation], [type definition]
@@ -28,6 +42,29 @@ Features:
2842
[semantic syntax highlighting]: https://rust-analyzer.github.io/manual.html#semantic-syntax-highlighting
2943
[assist(code actions)]: https://rust-analyzer.github.io/manual.html#assists-code-actions
3044

45+
46+
3147
[manual]: https://rust-analyzer.github.io/manual.html
3248

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+
3370
See https://rust-analyzer.github.io/ for more information.

0 commit comments

Comments
 (0)