From 2518789a5fd5725f7b3cc6025173804097a2c30f Mon Sep 17 00:00:00 2001 From: Kirill Mikhailov <62840029+playfulFence@users.noreply.github.com> Date: Mon, 21 Jul 2025 16:25:11 +0200 Subject: [PATCH] cleanup `esp-wifi` README (#3841) * cleanup `esp-wifi` README * better links format * lose weight, less words --- esp-wifi/README.md | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/esp-wifi/README.md b/esp-wifi/README.md index 3fb101a1d..32c356a6c 100644 --- a/esp-wifi/README.md +++ b/esp-wifi/README.md @@ -12,7 +12,7 @@ Note that this crate currently requires you to enable the `unstable` feature on ## Current support -If a cell contains an em dash (—) this means that the particular feature is not present for a chip. A check mark (✓) means that some driver implementation exists. A Tilde (˜) means it is implemented but buggy. An empty cell means that the feature is present in the chip but not implemented yet. +If a cell contains an em dash (—) this means that the particular feature is not present for a chip. A check mark (✓) means that some driver implementation exists. | | [Wifi](https://github.com/esp-rs/esp-wifi/issues/94) | [BLE](https://github.com/esp-rs/esp-wifi/issues/93) | [Coex](https://github.com/esp-rs/esp-wifi/issues/92) | ESP-NOW | | :------: | :--------------------------------------------------: | :-------------------------------------------------: | :--------------------------------------------------: | :-----: | @@ -28,14 +28,11 @@ If a cell contains an em dash (—) this means that the particular feature i - Support for non-open SoftAP -## Directory Structure +## Bluetooth stack +We recommend using [`TrouBLE`] as the Bluetooth stack. You can find detailed examples [here]. -- `src/timer/`: systimer code used for timing and task switching -- `src/preemt/`: a bare minimum RISCV and Xtensa round-robin task scheduler -- `src/compat/`: code needed to emulate enough of an (RT)OS to use the driver - - `common.rs`: basics like semaphores and recursive mutexes - - `timer_compat.rs`: code to emulate timer related functionality -- `examples/*.rs`: examples +[`TrouBLE`]: https://github.com/embassy-rs/trouble/tree/main +[here]: https://github.com/embassy-rs/trouble/tree/main/examples/esp32 ## Driver version