Skip to content

Commit

Permalink
doc(readme): minor update
Browse files Browse the repository at this point in the history
  • Loading branch information
HaoboGu authored Jan 30, 2024
1 parent 1547bfa commit b26c282
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@ This crate requires stable Rust 1.75 and up. `openocd`(stm32) or `probe-rs`(stm3

## Usage

### Initialize from template
### Option 1: Initialize from template
You can use [rmk-template](https://github.com/HaoboGu/rmk-template) to initialize your project.

```
cargo install cargo-generate
cargo generate --git https://github.com/HaoboGu/rmk-template
```

### Try built-in examples
### Option 2: Try built-in examples

Example can be found at [`boards`](https://github.com/HaoboGu/rmk/blob/main/boards). The following is a simple
step-to-step instruction for rp2040 and stm32h7
Expand Down

0 comments on commit b26c282

Please sign in to comment.