Make it more explicit that the esp-idf-* crates are a community effort only

This commit is contained in:
ivmarkov 2025-05-05 16:09:47 +00:00
parent 339b2425db
commit 2ee6e877e8

View File

@ -17,6 +17,16 @@
(For baremetal Rust ESP projects please check [`esp-hal`](https://github.com/esp-rs/esp-hal).)
## Commuity Effort
Please note that **all `esp-idf-*` crates are a community effort**, in that Espressif puts little to no paid developer time in these.
So while ESP-IDF itself is very popular and well tested, the `esp-idf-*` crates:
- Might be lagging behind a bit the latest stable ESP-IDF version
- Are (currently) missing HIL tests
- Need more documentation
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.
## Build Prerequisites
Follow the [Prerequisites](https://github.com/esp-rs/esp-idf-template#prerequisites) section in the `esp-idf-template` crate.