From 307b65474171338dd14c7dab9e687debc7cd56f1 Mon Sep 17 00:00:00 2001 From: Dickless <011001nobuo@gmail.com> Date: Wed, 11 Sep 2024 14:45:06 +0900 Subject: [PATCH] Add simple instruction to run examples --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 56ff1e6..72826cd 100644 --- a/README.md +++ b/README.md @@ -9,4 +9,26 @@ I have referred to the following: - - -Run examples with `cargo run --example ` +## Supported Daisy + +- Daisy Seed 1.1(rev5, with WM8731) +- Daisy Seed 1.2(rev7, with PCM3060) + +not yet support Daisy Seed(with AK4556), Daisy Patch SM. + +## Run Examples + +The first thing we'd like you to do is to run one of the examples on your Daisy board. + +### Prerequisites + +You can choose your preferred toolset to run the examples, but we recommend you to install [probe-rs](https://github.com/probe-rs/probe-rs) + +### Which Daisy Board You Have? + +- If you have `rev5`, it's defaulted.So you don't have to care about options. +- If you have `rev7`, add `--features=seed_1_2 --no-default-features` option each time you run an example. + +### Choose a Example You Want to Run + +You can run examples with `cargo run --example `.