Skip to content

Commit 52df816

Browse files
committed
Add a note regarding the devkit support policy to package-level README.md (#855)
1 parent 64d001a commit 52df816

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

cargo-espflash/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Supports the **ESP32**, **ESP32-C2/C3/C6**, **ESP32-H2**, **ESP32-P4**, and **ES
2020
- [Configuration File](#configuration-file)
2121
- [Configuration Precedence](#configuration-precedence)
2222
- [Logging Format](#logging-format)
23+
- [Development Kit Support Policy](#development-kit-support-policy)
2324
- [License](#license)
2425
- [Contribution](#contribution)
2526

@@ -173,6 +174,14 @@ You can have a local and/or a global configuration file:
173174
[`defmt` section]: https://github.com/esp-rs/esp-hal/tree/main/esp-println#defmt
174175
[`defmt` project]: https://docs.esp-rs.org/no_std-training/03_7_defmt.html
175176

177+
## Development Kit Support Policy
178+
179+
While in an ideal world we would aim to provide full support for all available development kits, this is unfortunately not achievable in practice. Instead, we aim to ensure full compatibility with all [official Espressif development kits].
180+
181+
We do not expect issues with third-party kits, however occasion issues do crop up. When this happens, if users expect fixes to be made then they are expected to debug the issue themselves so that a fix can be formulated; we cannot always reproduce these problems ourselves, and it's not reasonable to expect us to purchase every development kit users may experience issues with.
182+
183+
[official Espressif development kits]: https://www.espressif.com/en/products/devkits
184+
176185
## License
177186

178187
Licensed under either of:

espflash/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ Supports the **ESP32**, **ESP32-C2/C3/C6**, **ESP32-H2**, **ESP32-P4**, and **ES
2222
- [Configuration File](#configuration-file)
2323
- [Configuration Precedence](#configuration-precedence)
2424
- [Logging Format](#logging-format)
25+
- [Development Kit Support Policy](#development-kit-support-policy)
2526
- [License](#license)
2627
- [Contribution](#contribution)
2728

@@ -193,6 +194,14 @@ You can have a local and/or a global configuration file:
193194
[`defmt` section]: https://github.com/esp-rs/esp-hal/tree/main/esp-println#defmt
194195
[`defmt` project]: https://docs.esp-rs.org/no_std-training/03_7_defmt.html
195196

197+
## Development Kit Support Policy
198+
199+
While in an ideal world we would aim to provide full support for all available development kits, this is unfortunately not achievable in practice. Instead, we aim to ensure full compatibility with all [official Espressif development kits].
200+
201+
We do not expect issues with third-party kits, however occasion issues do crop up. When this happens, if users expect fixes to be made then they are expected to debug the issue themselves so that a fix can be formulated; we cannot always reproduce these problems ourselves, and it's not reasonable to expect us to purchase every development kit users may experience issues with.
202+
203+
[official Espressif development kits]: https://www.espressif.com/en/products/devkits
204+
196205
## License
197206

198207
Licensed under either of:

0 commit comments

Comments
 (0)