Skip to content

Commit

Permalink
docs: Update usage
Browse files Browse the repository at this point in the history
  • Loading branch information
SergioGasquez committed Oct 4, 2023
1 parent def9dd6 commit a3999e6
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 11 deletions.
13 changes: 8 additions & 5 deletions cargo-espflash/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,12 +72,15 @@ Cargo subcommand for flashing Espressif devices
Usage: cargo espflash <COMMAND>
Commands:
board-info Establish a connection with a target device
board-info Print information about a connected target device
completions Generate completions for the given shell
flash Build and flash an application to a target device
monitor Open the serial monitor without flashing
partition-table Operations for partitions tables
save-image Save the image to disk instead of flashing to device
erase-flash Erase Flash entirely
erase-parts Erase specified partitions
erase-region Erase specified region
flash Flash an application in ELF format to a target device
monitor Open the serial monitor without flashing the connected target device
partition-table Convert partition tables between CSV and binary format
save-image Generate a binary application image and save it to a local disk
help Print this message or the help of the given subcommand(s)
Options:
Expand Down
15 changes: 9 additions & 6 deletions espflash/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,13 +66,16 @@ A command-line tool for flashing Espressif devices
Usage: espflash <COMMAND>
Commands:
board-info Establish a connection with a target device
board-info Print information about a connected target device
completions Generate completions for the given shell
flash Flash an application to a target device
monitor Open the serial monitor without flashing
partition-table Operations for partitions tables
save-image Save the image to disk instead of flashing to device
write-bin Writes a binary file to a specific address in the chip's flash
erase-flash Erase Flash entirely
erase-parts Erase specified partitions
erase-region Erase specified region
flash Flash an application in ELF format to a connected target device
monitor Open the serial monitor without flashing the connected target device
partition-table Convert partition tables between CSV and binary format
save-image Generate a binary application image and save it to a local disk
write-bin Write a binary file to a specific address in a target device's flash
help Print this message or the help of the given subcommand(s)
Options:
Expand Down

0 comments on commit a3999e6

Please sign in to comment.