update project files (#17)

Add .cargo/config.toml aliases and documentation to allow easier running of the examples from the project root.

Author: robamu

esp-hal-buzzer/.cargo/config.toml .cargo/config.tomlesp-hal-buzzer/.cargo/config.toml renamed to .cargo/config.toml

@@ -7,6 +7,13 @@ esp32h2 = "run --release --features=esp32h2 --target=riscv32imac-unknown-none-el
 esp32s2 = "run --release --features=esp32s2 --target=xtensa-esp32s2-none-elf"
 esp32s3 = "run --release --features=esp32s3 --target=xtensa-esp32s3-none-elf"
 
+[build]
+target = "riscv32imac-unknown-none-elf"
+# target = "riscv32imc-unknown-none-elf"
+# target = "xtensa-esp32s2-none-elf"
+# target = "xtensa-esp32s3-none-elf"
+# target = "xtensa-esp32-none-elf"
+
 [target.'cfg(target_arch = "riscv32")']
 runner    = "espflash flash --monitor"
 rustflags = [
@@ -27,4 +34,4 @@ rustflags = [
 ]
 
 [unstable]
-build-std = ["core"]
+build-std = ["alloc", "core"]

README.md

@@ -8,6 +8,17 @@ A collection of crates for use alongside [esp-hal], but which are maintained by
 
 [esp-hal]: https://github.com/esp-rs/esp-hal/
 
+## Examples
+
+To run the examples for either crate, either open the project at the sub-crate level or change directory:
+
+```bash
+# cd into crate directory for smartled or buzzer
+cd esp-hal-smartled
+# cargo <chip alias> --example <example name>
+cargo esp32c3 --example hello_rgb # or other chip
+```
+
 ## Contributing a Crate
 
 If you have a crate which depends on `esp-hal` and provides some additional functionality, we encourage you to contribute it to this repository!

esp-hal-smartled/.cargo/config.toml

@@ -0,0 +1,2 @@
+# Ignore file because it will be different based on test target.
+/rust-toolchain.toml

esp-hal-smartled/.gitignore

@@ -0,0 +1,4 @@
+[toolchain]
+channel = "stable"
+components = ["rust-src"]
+targets = ["riscv32imac-unknown-none-elf", "riscv32imac-unknown-none-elf"]

rust-toolchain-risc-v.toml

@@ -0,0 +1,2 @@
+[toolchain]
+channel = "esp"