Skip to content

Commit 441a0b4

Browse files
committed
Update CLI --help output in README
1 parent 817652b commit 441a0b4

1 file changed

Lines changed: 10 additions & 11 deletions

File tree

README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -45,24 +45,23 @@ Mcbootflash can be used as both a command-line application and a library.
4545

4646
```shellsession
4747
$ mcbootflash --help
48-
usage: mcbootflash [-h] -p PORT -b BAUDRATE [-t TIMEOUT] [-c] [-r] [-v] [-q] [--version] hexfile
48+
usage: mcbootflash [-h] -p PORT -b BAUDRATE [--timeout TIMEOUT] [--checksum] [--reset] [--debug] [--quiet] [--version] hexfile
4949

50-
Flash firmware over serial connection to a device running Microchip's 16-bit bootloader.
50+
mcbootflash is a tool for flashing firmware to 16-bit Microchip MCUs and DSCs from the PIC24 and dsPIC33 device families, which are running a bootloader generated by the MPLAB Code Configurator tool.
5151

5252
positional arguments:
53-
hexfile a HEX file containing application firmware
53+
hexfile an Intel HEX file containing application firmware
5454

5555
options:
5656
-h, --help show this help message and exit
57-
-p PORT, --port PORT serial port connected to the device you want to flash
58-
-b BAUDRATE, --baudrate BAUDRATE
57+
-p, --port PORT serial port connected to the device you want to flash
58+
-b, --baudrate BAUDRATE
5959
symbol rate of device's serial bus
60-
-t TIMEOUT, --timeout TIMEOUT
61-
try to read data from the bus for this many seconds before giving up
62-
-c, --checksum verify flashed data by checksumming after write
63-
-r, --reset reset device after flashing is complete
64-
-v, --verbose print debug messages
65-
-q, --quiet suppress output
60+
--timeout TIMEOUT try to read data from the bus for this many seconds before giving up
61+
--checksum verify flashed data by checksumming after write
62+
--reset reset device after flashing is complete
63+
--debug print debug messages
64+
--quiet suppress output
6665
--version show program's version number and exit
6766
```
6867

0 commit comments

Comments
 (0)