Skip to content

Commit f5c25f6

Browse files
bors[bot]IceSentry
andauthored
Merge #7837
7837: Add more information to VSCode extenstion README r=matklad a=IceSentry 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 Co-authored-by: Charles Giguere <[email protected]> Co-authored-by: cgiguere <[email protected]>
2 parents 8d2b0e6 + 3df8df2 commit f5c25f6

File tree

1 file changed

+51
-11
lines changed

1 file changed

+51
-11
lines changed

editors/code/README.md

Lines changed: 51 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,36 @@
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.
78

8-
* [code completion], [imports insertion]
9-
* [go to definition], [implementation], [type definition]
10-
* [find all references], [workspace symbol search], [rename]
11-
* [types and documentation on hover]
12-
* [inlay hints]
13-
* [semantic syntax highlighting]
14-
* a lot of [assist(code actions)]
15-
* apply suggestions from errors
16-
* ... and many more, checkout the [manual] to see them all
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+
15+
- [Mozilla](https://www.mozilla.org/en-US/)
16+
- [Embark Studios](https://embark-studios.com/)
17+
- [freiheit.com](https://www.freiheit.com)
18+
19+
If you want to sponsor:
20+
21+
- [OpenCollective](https://opencollective.com/rust-analyzer/)
22+
- [Github Sponsors](https://github.com/sponsors/rust-analyzer)
23+
24+
## Features
25+
26+
- [code completion], [imports insertion]
27+
- [go to definition], [implementation], [type definition]
28+
- [find all references], [workspace symbol search], [rename]
29+
- [types and documentation on hover]
30+
- [inlay hints]
31+
- [semantic syntax highlighting]
32+
- a lot of [assist(code actions)]
33+
- apply suggestions from errors
34+
- ... and many more, checkout the [manual] to see them all
1735

1836
[code completion]: https://rust-analyzer.github.io/manual.html#magic-completions
1937
[imports insertion]: https://rust-analyzer.github.io/manual.html#auto-import
@@ -30,4 +48,26 @@ Features:
3048

3149
[manual]: https://rust-analyzer.github.io/manual.html
3250

33-
See https://rust-analyzer.github.io/ for more information.
51+
## Quick start
52+
53+
1. Install [rustup]
54+
2. Install the [rust-analyzer extension]
55+
56+
[rustup]: https://rustup.rs
57+
[rust-analyzer extension]: https://marketplace.visualstudio.com/items?itemName=matklad.rust-analyzer
58+
59+
## Configuration
60+
61+
This extension provides configurations through VSCode's configuration settings. All the configurations are under `rust-analyzer.*`.
62+
63+
See <https://rust-analyzer.github.io/manual.html#vs-code-2> for more information on VSCode specific configurations.
64+
65+
## Communication
66+
67+
For usage and troubleshooting requests, please use "IDEs and Editors" category of the Rust forum:
68+
69+
<https://users.rust-lang.org/c/ide/14>
70+
71+
## Documentation
72+
73+
See <https://rust-analyzer.github.io/> for more information.

0 commit comments

Comments
 (0)