From a0de1723bd0a792181eb439e7da9ecc2ba76b502 Mon Sep 17 00:00:00 2001 From: Charles Giguere Date: Mon, 1 Mar 2021 14:47:54 -0500 Subject: [PATCH] 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 --- editors/code/README.md | 39 ++++++++++++++++++++++++++++++++++++++- 1 file changed, 38 insertions(+), 1 deletion(-) diff --git a/editors/code/README.md b/editors/code/README.md index e7d7a06f0e..67df34f7eb 100644 --- a/editors/code/README.md +++ b/editors/code/README.md @@ -2,8 +2,22 @@ Provides support for rust-analyzer: novel LSP server for the Rust programming language. +**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. -Features: +**Note** the project is in alpha status: it is already useful in practice, but can't be considered stable. + +## Sponsor + +Work on rust-analyzer is sponsored by + +[Ferrous Systems](https://ferrous-systems.com/) +- [Mozilla](https://www.mozilla.org/en-US/) +- [Embark Studios](https://embark-studios.com/) +- [freiheit.com](https://www.freiheit.com) + + + +## Features * [code completion], [imports insertion] * [go to definition], [implementation], [type definition] @@ -28,6 +42,29 @@ Features: [semantic syntax highlighting]: https://rust-analyzer.github.io/manual.html#semantic-syntax-highlighting [assist(code actions)]: https://rust-analyzer.github.io/manual.html#assists-code-actions + + [manual]: https://rust-analyzer.github.io/manual.html +## Quick start +1. Install [rustup] the rust toolchain +2. Install the [rust-analyzer extension] + +[rustup]: https://rustup.rs +[rust-analyzer extension]: https://marketplace.visualstudio.com/items?itemName=matklad.rust-analyzer + +## Configuration + +This extension provides configurations through VSCode's configuration settings. All the configurations are under `rust-analyzer.*`. + +See https://rust-analyzer.github.io/manual.html#vs-code-2 for more information on VSCode specific configurations. + +## Communication + +For usage and troubleshooting requests, please use "IDEs and Editors" category of the Rust forum: + +https://users.rust-lang.org/c/ide/14 + +## Documentation + See https://rust-analyzer.github.io/ for more information.