Skip to content

Commit caf0b4f

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

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,16 @@
2323
> this process run cargo with the `-vv` (very verbose) flag, so that build script output
2424
> is also displayed. This is especially useful since the initial build will take a while.
2525
26+
## Commuity Effort
27+
28+
Please note that **all `esp-idf-*` crates are a community effort**, in that Espressif puts little to no paid developer time in these.
29+
So while ESP-IDF itself is very popular and well tested, the `esp-idf-*` crates:
30+
- Might be a bit lagging behind the latest stable ESP-IDF version
31+
- Are (currently) missing HIL tests
32+
- Need more documentation
33+
34+
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.
35+
2636
## Build Prerequisites
2737

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

0 commit comments

Comments
 (0)