Merge pull request #49 from knurling-rs/doc-ra-linked-projects

`README.md`: Document `rust-analyzer.linkedProjects`
2021-04-13 13:05:09 +02:00
parent d0aa56c67d 5737b08a58
commit 9e46054e03
1 changed files with 16 additions and 0 deletions
@@ -138,6 +138,22 @@ $ echo $?
 0
 ```

+### (8. Set `rust-analyzer.linkedProjects`)
+
+If you are using [rust-analyzer] with VS Code for IDE-like features you can add following configuration to your `.vscode/settings.json` to make it work transparently across workspaces. Find the details of this option in the [RA docs].
+
+```json
+{
+    "rust-analyzer.linkedProjects": [
+        "Cargo.toml",
+        "firmware/Cargo.toml",
+    ]
+} 
+```
+
+[RA docs]: https://rust-analyzer.github.io/manual.html#configuration
+[rust-analyzer]: https://rust-analyzer.github.io/
+
 ## Trying out the git version of defmt

 This template is configured to use the latest crates.io release (the "stable" release) of the `defmt` framework.