Skip to content

Commit b872232

Browse files
committed
chore(README): touch up formatting
1 parent c0c82cb commit b872232

File tree

1 file changed

+28
-17
lines changed

1 file changed

+28
-17
lines changed

README.md

Lines changed: 28 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,55 @@
11
# [Documentation](https://docs.rs/libdaisy)
22

33
# libdaisy
4+
45
Hardware Abstraction Layer implementation for Daisy boards.
56

67
## Requirements
7-
* Hardware target
8-
```
9-
$ rustup target add thumbv7em-none-eabihf
10-
```
118

12-
* [cargo-binutils][cargo-binutils-url]
13-
``` console
14-
$ cargo install cargo-binutils
9+
- Hardware target
1510

16-
$ rustup component add llvm-tools-preview
11+
```bash
12+
rustup target add thumbv7em-none-eabihf
1713
```
18-
# A Flashing Utility
19-
* [Electro-smith web programmer](https://electro-smith.github.io/Programmer/)
2014

21-
OR
15+
- [cargo-binutils][cargo-binutils-url]
2216

23-
* [dfu-util](http://dfu-util.sourceforge.net/)
17+
```bash
18+
cargo install cargo-binutils
2419

25-
OR
20+
rustup component add llvm-tools-preview
21+
```
2622

27-
* [Probe.rs](https://probe.rs/)
23+
# A Flashing Utility
24+
25+
One of:
2826

29-
This requires a debug probe of some sort (e.g. ST link) and allows for fast debugging messages via RTT.
27+
- [electro-smith web programmer](https://electro-smith.github.io/Programmer/)
28+
- [dfu-util](http://dfu-util.sourceforge.net/)
29+
- [probe.rs](https://probe.rs/)
3030

31+
`probe.rs` requires a debug probe of some sort (e.g. ST link) and allows for fast debugging messages via RTT.
32+
33+
```bash
3134
cargo embed --features log-rtt --example passthru
35+
```
3236

3337
## Build Examples
38+
39+
```bash
3440
cargo objcopy --example blinky --release -- -O binary blinky.bin
41+
```
3542

43+
```bash
3644
cargo objcopy --example passthru --release -- -O binary passthru.bin
37-
38-
[cargo-binutils-url]: https://github.com/rust-embedded/cargo-binutils
45+
```
3946

4047
# Minimum supported Rust version
48+
4149
The Minimum Supported Rust Version (MSRV) at the moment is 1.51.0.
50+
4251
# Demos
4352

4453
[Looper](https://github.com/mtthw-meyer/daisy-looper) - Basic one button looper.
54+
55+
[cargo-binutils-url]: https://github.com/rust-embedded/cargo-binutils

0 commit comments

Comments
 (0)