Rust Analyzer documentation

Intends to clarify how to make Embassy usable from within Visual Studio Code by assuming the presence of the Rust Analyzer.

Note that IntelliJ does not support the Rust Analyzer, so an open question remains as to the whether this is a good move. If it turns out not to be a good move then we should still look at clarifying the use of a workspace file.

1 files changed, 0 insertions, 93 deletions

diff --git a/Cargo.example.toml b/Cargo.example.toml
deleted file mode 100644
index 3fa8a32e9..000000000
--- a/Cargo.example.toml
+++ /dev/null
@@ -1,93 +0,0 @@
-# This file is a template for a Cargo workspace for developer convenience.
-#
-# Since Cargo resolves all features for all crates in the workspace together, 
-# it is not possible to have a workspace with all the crates together, since they
-# enable incompatible features. For example, nrf crates enable embassy-macros/nrf
-# and stm32 crates enable embassy-macros/stm32. embassy-macros doesn't support having
-# both of these features on at the same time, because it makes no sense.
-#
-# Instead, we provide this template so you can enable only the crates you're going to
-# work on. This makes eg rust-analyzer check-on-save and autocomplete work, but only 
-# in these crates, without any feature conflict.
-#
-# Copy this file to `Cargo.toml` and uncomment one group of crates below.
-#
-# `/Cargo.toml` is already in .gitignore, so you don't commit it accidentally.
-
-[workspace]
-resolver = "2"
-
-members = [
-    "embassy",
-    "embassy-traits",
-    "embassy-macros",
-    "embassy-hal-common",
-    "embassy-net",
-
-    # Uncomment ONLY ONE of the groups below.
-
-    # nRF
-    #"embassy-nrf",
-    #"examples/nrf",
-
-    # stm32
-    #"embassy-stm32",
-    #"stm32-metapac",
-    # uncomment ONLY ONE example crate.
-    #"examples/stm32f0",
-    #"examples/stm32f1",
-    #"examples/stm32f4",
-    #"examples/stm32f7",
-    #"examples/stm32g0",
-    #"examples/stm32h7",
-    #"examples/stm32l0",
-    #"examples/stm32l1",
-    #"examples/stm32l4",
-    #"examples/stm32wb55",
-    #"examples/stm32wl55",
-
-    # rp2040
-    #"embassy-rp",
-    #"examples/rp",
-
-    # std
-    #"examples/std",
-]
-
-exclude = [
-    # This is only built as a build-dependency, for the host. It shouldn't
-    # get built for the target.
-    "stm32-metapac-gen"
-]
-
-[profile.dev]
-codegen-units = 1
-debug = 2
-debug-assertions = true
-incremental = false
-opt-level = 3
-overflow-checks = true
-
-[profile.release]
-codegen-units = 1
-debug = 2
-debug-assertions = false
-incremental = false
-lto = "fat"
-opt-level = 's'
-overflow-checks = false
-
-# do not optimize proc-macro crates = faster builds from scratch
-[profile.dev.build-override]
-codegen-units = 8
-debug = false
-debug-assertions = false
-opt-level = 0
-overflow-checks = false
-
-[profile.release.build-override]
-codegen-units = 8
-debug = false
-debug-assertions = false
-opt-level = 0
-overflow-checks = false