From 2ee6e877e83dfa75e6ea79339cdf3e91b1dc77f6 Mon Sep 17 00:00:00 2001 From: ivmarkov Date: Mon, 5 May 2025 16:09:47 +0000 Subject: [PATCH] Make it more explicit that the esp-idf-* crates are a community effort only --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index bf7ba186a..f41d653b2 100644 --- a/README.md +++ b/README.md @@ -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.