Skip to content

Commit

Permalink
Add simple instruction to run examples
Browse files Browse the repository at this point in the history
  • Loading branch information
Dicklessgreat committed Sep 11, 2024
1 parent 6ad8534 commit 307b654
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,26 @@ I have referred to the following:
- <https://github.com/zlosynth/daisy>
- <https://github.com/mtthw-meyer/libdaisy-rust>

Run examples with `cargo run --example <example_name>`
## 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 <example_name>`.

0 comments on commit 307b654

Please sign in to comment.