Skip to content

Commit

Permalink
Mention the bootloader/partition table auto-detection feature of `car…
Browse files Browse the repository at this point in the history
…go-espflash`
  • Loading branch information
jessebraham committed Dec 20, 2022
1 parent 8f34836 commit f10d0fd
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions cargo-espflash/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit f10d0fd

Please sign in to comment.