Skip to content

Commit 4b39b3b

Browse files
committed
readme updates
1 parent a477798 commit 4b39b3b

File tree

3 files changed

+9
-8
lines changed

3 files changed

+9
-8
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# ESPFlash
22
[![Actions Status](https://github.com/esp-rs/espflash/workflows/CI/badge.svg)](https://github.com/esp-rs/espflash/actions?query=workflow%3A"CI")
33

4-
_ESP8266_ and _ESP32_ serial flasher based on [esptool.py](https://github.com/espressif/esptool).
4+
_ESP8266_ and _ESP32_ family serial flasher based on [esptool.py](https://github.com/espressif/esptool).
55

6-
* [espflash library & binary](https://github.com/icewind1991/espflash/tree/master/espflash)
7-
* [espflash cargo subcommand](https://github.com/icewind1991/espflash/tree/master/cargo-espflash)
6+
* [espflash library & binary](https://github.com/esp-rs/espflash/tree/master/espflash)
7+
* [espflash cargo subcommand](https://github.com/esp-rs/espflash/tree/master/cargo-espflash)
88

99
## Status
1010

11-
Flashing _should_ work for both ESP32 and ESP8266.
11+
Flashing _should_ work for __ESP32__, __ESP32-S3__, __ESP32-C3__, and __ESP8266__.
1212

1313
If you have an ELF file that flashes correctly with `esptool.py` but not with this tool then please open an issue with the ELF in question.
1414

cargo-espflash/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# `cargo-espflash`
22

3-
Cross-compiler and serial flasher cargo subcommand for Espressif devices. Currently supports __ESP32__, __ESP32-C3__, and __ESP8266__.
3+
Cross-compiler and serial flasher cargo subcommand for Espressif devices. Currently supports __ESP32__, __ESP32-S3__, __ESP32-C3__, and __ESP8266__.
44

55
Prior to flashing, the project is built using the `build-std` unstable cargo feature. Please refer to the [cargo documentation](https://doc.rust-lang.org/cargo/reference/unstable.html#build-std) for more information.
66

@@ -16,6 +16,7 @@ USAGE:
1616
FLAGS:
1717
--board-info Display the connected board's information
1818
-h, --help Prints help information
19+
--monitor Open a serial monitor after flashing
1920
--ram Load the application to RAM instead of Flash
2021
--release Build the application using the release profile
2122
-V, --version Prints version information
@@ -56,7 +57,7 @@ bootloader = "bootloader.bin"
5657
### Example
5758

5859
```bash
59-
$ cargo espflash --release --example=blinky /dev/ttyUSB0
60+
$ cargo espflash --release --example blinky /dev/ttyUSB0
6061
```
6162

6263
## License

espflash/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# `espflash`
22

3-
_ESP8266_ and _ESP32_ serial flasher library and CLI application.
3+
__ESP32__, __ESP32-S3__, __ESP32-C3__, and __ESP8266__ serial flasher library and CLI application.
44

55
[![asciicast](https://asciinema.org/a/367205.svg)](https://asciinema.org/a/367205)
66

@@ -17,7 +17,7 @@ When the `--board-info` is specified, instead of flashing anything, the chip typ
1717
### Config
1818

1919
You can also specify the serial port by setting it in the config file located at `~/.config/espflash/espflash.toml` or linux
20-
or `%APPDATA%/esp/espflash/espflash.toml` on windows.
20+
or `%APPDATA%/esp/espflash/espflash.toml` on Windows.
2121

2222
```toml
2323
[connection]

0 commit comments

Comments
 (0)