diff --git a/README.md b/README.md index acd057e054efbc6f5e3df5fc9bf949f2bfc27a7d..b483b109d3076ce4d59d3953d8ec777795494b5e 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,17 @@ This repo provides a pure-rust board support crate / runtime + drivers for the h If you are interested in implementing or testing one of the missing features, I am always happy for any help. Just open an issue or reach out via matrix (@zdmx:xatellite.space) or e-mail. +## Getting started + +To easily set up a project with `flow3-rs` and `flow3-rs-rt`, use cargo generate: + +``` +cargo generate --git https://git.flow3r.garden/flow3r/flow3-rs +``` + +This will create a minimal project for you to get started. If you have not used ESP32/Xtensa with Rust before, you will also need to setup the toolchain. +Continue reading below on how to do that. + ## Development setup The hardware of the badge is based on the ESP32S3 which uses the Xtensa-Architecture. Xtensa is currently not supported in mainline LLVM/rustc, so we have to install the Espressif-forks of the toolchain. diff --git a/flow3-rs-template/Cargo.toml b/flow3-rs-template/Cargo.toml index a674be51175cbee900af2e22a5b04a59f6b30e5a..58b47646d57805159c797a0863da4d5ee73ba5c6 100644 --- a/flow3-rs-template/Cargo.toml +++ b/flow3-rs-template/Cargo.toml @@ -1,5 +1,5 @@ [package] -name = "template" +name = "{{project-name}}" version = "0.1.0" edition = "2021" @@ -11,5 +11,5 @@ embassy-time = { version = "=0.1.2", features = ["nightly", "unstable-traits"] } esp-backtrace = { version = "0.7.0", features = ["esp32s3", "panic-handler", "exception-handler", "print-uart"] } esp-println = { version = "0.5.0", features = ["esp32s3"] } hal = { package = "esp32s3-hal", version = "0.11.0", features = ["embassy", "async", "embassy-time", "embassy-time-systick"] } -flow3-rs = { path = "../flow3-rs" } -flow3-rs-rt = { path = "../flow3-rs-rt" } +flow3-rs = { git = "https://git.flow3r.garden/flow3r/flow3-rs.git" } +flow3-rs-rt = { git = "https://git.flow3r.garden/flow3r/flow3-rs.git" }