diff --git a/editors/code/README.md b/editors/code/README.md index e7d7a06f0e..2414892266 100644 --- a/editors/code/README.md +++ b/editors/code/README.md @@ -2,18 +2,36 @@ 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. -* [code completion], [imports insertion] -* [go to definition], [implementation], [type definition] -* [find all references], [workspace symbol search], [rename] -* [types and documentation on hover] -* [inlay hints] -* [semantic syntax highlighting] -* a lot of [assist(code actions)] -* apply suggestions from errors -* ... and many more, checkout the [manual] to see them all +## 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) + +If you want to sponsor: + +- [OpenCollective](https://opencollective.com/rust-analyzer/) +- [Github Sponsors](https://github.com/sponsors/rust-analyzer) + +## Features + +- [code completion], [imports insertion] +- [go to definition], [implementation], [type definition] +- [find all references], [workspace symbol search], [rename] +- [types and documentation on hover] +- [inlay hints] +- [semantic syntax highlighting] +- a lot of [assist(code actions)] +- apply suggestions from errors +- ... and many more, checkout the [manual] to see them all [code completion]: https://rust-analyzer.github.io/manual.html#magic-completions [imports insertion]: https://rust-analyzer.github.io/manual.html#auto-import @@ -30,4 +48,26 @@ Features: [manual]: https://rust-analyzer.github.io/manual.html -See https://rust-analyzer.github.io/ for more information. +## Quick start + +1. Install [rustup] +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 for more information on VSCode specific configurations. + +## Communication + +For usage and troubleshooting requests, please use "IDEs and Editors" category of the Rust forum: + + + +## Documentation + +See for more information.