Skip to content

Commit 3b024fc

Browse files
Update readme (#484)
* docs: Update ToC * docs: Update usage
1 parent b215570 commit 3b024fc

File tree

2 files changed

+23
-12
lines changed

2 files changed

+23
-12
lines changed

cargo-espflash/README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ Supports the **ESP32**, **ESP32-C2/C3/C6**, **ESP32-H2**, **ESP32-S2/S3**, and *
1717
- [Bootloader and Partition Table](#bootloader-and-partition-table)
1818
- [Package Metadata](#package-metadata)
1919
- [Configuration File](#configuration-file)
20+
- [Configuration examples](#configuration-examples)
21+
- [License](#license)
22+
- [Contribution](#contribution)
2023

2124
## Installation
2225

@@ -69,12 +72,15 @@ Cargo subcommand for flashing Espressif devices
6972
Usage: cargo espflash <COMMAND>
7073
7174
Commands:
72-
board-info Establish a connection with a target device
75+
board-info Print information about a connected target device
7376
completions Generate completions for the given shell
74-
flash Build and flash an application to a target device
75-
monitor Open the serial monitor without flashing
76-
partition-table Operations for partitions tables
77-
save-image Save the image to disk instead of flashing to device
77+
erase-flash Erase Flash entirely
78+
erase-parts Erase specified partitions
79+
erase-region Erase specified region
80+
flash Flash an application in ELF format to a target device
81+
monitor Open the serial monitor without flashing the connected target device
82+
partition-table Convert partition tables between CSV and binary format
83+
save-image Generate a binary application image and save it to a local disk
7884
help Print this message or the help of the given subcommand(s)
7985
8086
Options:

espflash/README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,10 @@ Supports the **ESP32**, **ESP32-C2/C3/C6**, **ESP32-H2**, **ESP32-S2/S3**, and *
1616
- [Permissions on Linux](#permissions-on-linux)
1717
- [Windows Subsystem for Linux](#windows-subsystem-for-linux)
1818
- [Cargo Runner](#cargo-runner)
19-
- [Bootloader and Partition Table](#bootloader-and-partition-table)
2019
- [Configuration File](#configuration-file)
20+
- [Configuration examples](#configuration-examples)
21+
- [License](#license)
22+
- [Contribution](#contribution)
2123

2224
## Installation
2325

@@ -64,13 +66,16 @@ A command-line tool for flashing Espressif devices
6466
Usage: espflash <COMMAND>
6567
6668
Commands:
67-
board-info Establish a connection with a target device
69+
board-info Print information about a connected target device
6870
completions Generate completions for the given shell
69-
flash Flash an application to a target device
70-
monitor Open the serial monitor without flashing
71-
partition-table Operations for partitions tables
72-
save-image Save the image to disk instead of flashing to device
73-
write-bin Writes a binary file to a specific address in the chip's flash
71+
erase-flash Erase Flash entirely
72+
erase-parts Erase specified partitions
73+
erase-region Erase specified region
74+
flash Flash an application in ELF format to a connected target device
75+
monitor Open the serial monitor without flashing the connected target device
76+
partition-table Convert partition tables between CSV and binary format
77+
save-image Generate a binary application image and save it to a local disk
78+
write-bin Write a binary file to a specific address in a target device's flash
7479
help Print this message or the help of the given subcommand(s)
7580
7681
Options:

0 commit comments

Comments
 (0)