Skip to content

Commit e9d1f2a

Browse files
committed
Update READMEs to be more consistent with each other and other org projects
1 parent 55aacfd commit e9d1f2a

File tree

3 files changed

+60
-9
lines changed

3 files changed

+60
-9
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,15 @@ $ dnf install systemd-devel
8181

8282
## License
8383

84-
Espflash is distributed under the terms of both the MIT license and the Apache License (Version 2.0).
84+
Licensed under either of:
8585

86-
See [LICENSE-APACHE](./LICENSE-APACHE) and [LICENSE-MIT](./LICENSE-MIT) for more details. Files in the project may not be copied, modified, or distributed except according to those terms.
86+
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
87+
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
88+
89+
at your option.
90+
91+
### Contribution
92+
93+
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in
94+
the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without
95+
any additional terms or conditions.

cargo-espflash/README.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,26 @@ Cross-compiler and serial flasher cargo subcommand for Espressif SoCs and module
44

55
Currently supports the **ESP32**, **ESP32-C3**, **ESP32-S2**, **ESP32-S3**, and **ESP8266**.
66

7-
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.
7+
Prior to flashing, the project is built using the `build-std` unstable Cargo feature. Please refer to the [cargo documentation] for more information.
8+
9+
[cargo documentation]: https://doc.rust-lang.org/cargo/reference/unstable.html#build-std
810

911
## Installation
1012

1113
```shell
1214
$ cargo install cargo-espflash
1315
```
1416

17+
Alternatively, you can use [cargo-binstall] to install pre-compiled binaries on any supported system. Please check the [releases] to see which architectures and operating systems have pre-compiled binaries.
18+
19+
```shell
20+
$ cargo install cargo-binstall
21+
$ cargo binstall cargo-espflash
22+
```
23+
24+
[cargo-binstall]: https://github.com/ryankurte/cargo-binstall
25+
[releases]: https://github.com/esp-rs/espflash/releases
26+
1527
## Usage
1628

1729
```text
@@ -131,4 +143,15 @@ format = "direct-boot"
131143

132144
## License
133145

134-
Licensed under the GNU General Public License Version 2. See [LICENSE](LICENSE) for more details.
146+
Licensed under either of:
147+
148+
- Apache License, Version 2.0 ([LICENSE-APACHE](../LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
149+
- MIT license ([LICENSE-MIT](../LICENSE-MIT) or http://opensource.org/licenses/MIT)
150+
151+
at your option.
152+
153+
### Contribution
154+
155+
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in
156+
the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without
157+
any additional terms or conditions.

espflash/README.md

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,22 @@ Serial flasher utility for Espressif SoCs and modules.
44

55
Currently supports the **ESP32**, **ESP32-C3**, **ESP32-S2**, **ESP32-S3**, and **ESP8266**.
66

7-
[![asciicast](https://asciinema.org/a/UxRaCy4pretvGkghrRO0Qvypm.svg)](https://asciinema.org/a/UxRaCy4pretvGkghrRO0Qvypm)
8-
97
## Installation
108

119
```shell
1210
$ cargo install espflash
1311
```
1412

13+
Alternatively, you can use [cargo-binstall] to install pre-compiled binaries on any supported system. Please check the [releases] to see which architectures and operating systems have pre-compiled binaries.
14+
15+
```shell
16+
$ cargo install cargo-binstall
17+
$ cargo binstall espflash
18+
```
19+
20+
[cargo-binstall]: https://github.com/ryankurte/cargo-binstall
21+
[releases]: https://github.com/esp-rs/espflash/releases
22+
1523
## Usage
1624

1725
```text
@@ -88,8 +96,8 @@ An example configuration file may look as follows (note that TOML does _not_ sup
8896
serial = "/dev/ttyUSB0"
8997

9098
[[usb_device]]
91-
vid = 12346 # 0x303A
92-
pid = 32768 # 0x8000
99+
vid = "303A"
100+
pid = "8000"
93101
```
94102

95103
## WSL2
@@ -109,4 +117,15 @@ This then allows you to run your project using `cargo run`.
109117

110118
## License
111119

112-
Licensed under the GNU General Public License Version 2. See [LICENSE](LICENSE) for more details.
120+
Licensed under either of:
121+
122+
- Apache License, Version 2.0 ([LICENSE-APACHE](../LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
123+
- MIT license ([LICENSE-MIT](../LICENSE-MIT) or http://opensource.org/licenses/MIT)
124+
125+
at your option.
126+
127+
### Contribution
128+
129+
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in
130+
the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without
131+
any additional terms or conditions.

0 commit comments

Comments
 (0)