Skip to content

Commit 0985058

Browse files
committed
Make it more explicit that the esp-idf-* crates are a community effort only
1 parent b457f89 commit 0985058

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,16 @@
1515

1616
**You might want to also check out the ESP IDF [Drivers](https://github.com/esp-rs/esp-idf-hal) wrappers, and the raw bindings to ESP IDF in the [esp-idf-sys](https://github.com/esp-rs/esp-idf-sys) crate!**
1717

18+
## Commuity Effort
19+
20+
Please note that **all `esp-idf-*` crates are a community effort**, in that Espressif puts little to no paid developer time in these.
21+
So while ESP-IDF itself is very popular and well tested, the `esp-idf-*` crates:
22+
- Might be lagging behind a bit the latest stable ESP-IDF version
23+
- Are (currently) missing HIL tests
24+
- Need more documentation
25+
26+
For a HAL which is officially supported by Espressif (as in - with paid developer time), please look at [`esp-hal`](https://github.com/esp-rs/esp-hal). Keep in mind that `esp-hal` is `no_std`-only, does not use ESP-IDF and requires async programming.
27+
1828
## Build Prerequisites
1929

2030
Follow the [Prerequisites](https://github.com/esp-rs/esp-idf-template#prerequisites) section in the `esp-idf-template` crate.

0 commit comments

Comments
 (0)