From bd24712ac26c4041e8c07db590d75b6d46000ddd Mon Sep 17 00:00:00 2001 From: Jesse Braham Date: Tue, 20 Dec 2022 09:21:32 -0800 Subject: [PATCH] Mention the bootloader/partition table auto-detection feature of `cargo-espflash` --- cargo-espflash/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/cargo-espflash/README.md b/cargo-espflash/README.md index cb2516da..46fa0cea 100644 --- a/cargo-espflash/README.md +++ b/cargo-espflash/README.md @@ -65,6 +65,14 @@ Options: -V, --version Print version information ``` +## Bootloader and Partition Table + +`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. + +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`. + +[esp-idf-sys]: https://github.com/esp-rs/esp-idf-sys + ## Package Metadata 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: