Skip to content

Commit f10d0fd

Browse files
committed
Mention the bootloader/partition table auto-detection feature of cargo-espflash
1 parent 8f34836 commit f10d0fd

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

cargo-espflash/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,14 @@ Options:
6565
-V, --version Print version information
6666
```
6767

68+
## Bootloader and Partition Table
69+
70+
`cargo-espflash` is able to detect if the package being built and flashed depends on [esp-idf-sys]; if it does, then the bootloader and partition table built by the `esp-idf-sys` build script will be used, otherwise the bundled bootloader and partition tables will be used instead.
71+
72+
If the `--bootloader` and/or `--partition-table` options are provided then these will be used regardless of whether or not the package depends on `esp-idf-sys`.
73+
74+
[esp-idf-sys]: https://github.com/esp-rs/esp-idf-sys
75+
6876
## Package Metadata
6977

7078
You're able to specify paths to bootloader and partition table files ands image format in your package's Cargo metadata for per-project configuration:

0 commit comments

Comments
 (0)