diff --git a/esp-rtos/README.md b/esp-rtos/README.md index 8393872f4..9b75f0ac1 100644 --- a/esp-rtos/README.md +++ b/esp-rtos/README.md @@ -6,7 +6,7 @@  [](https://matrix.to/#/#esp-rs:matrix.org) -This crate implements [`esp-radio-rtos-driver`](https://crates.io/crates/esp-radio-rtos-driver) for firmwares using [esp-hal](https://crates.io/crates/esp-hal) without any additional software platform. +An RTOS (Real-Time Operating System) implementation for esp-hal. This crate provides the runtime necessary to run `async` code on top of esp-hal, and implements the necessary capabilities (threads, queues, etc.) required by esp-radio. ## Minimum Supported Rust Version (MSRV) diff --git a/esp-rtos/src/embassy/mod.rs b/esp-rtos/src/embassy/mod.rs index d0205a819..90105b267 100644 --- a/esp-rtos/src/embassy/mod.rs +++ b/esp-rtos/src/embassy/mod.rs @@ -43,7 +43,8 @@ pub trait Callbacks { /// Thread-mode executor. /// /// This executor runs in an OS thread, meaning the scheduler needs to be started before using any -/// async operations. +/// async operations. If you wish to write async code without the scheduler running, consider +/// using the [`InterruptExecutor`]. #[cfg_attr( multi_core, doc = r" diff --git a/esp-rtos/src/lib.rs b/esp-rtos/src/lib.rs index 630e7a42b..9254bc434 100644 --- a/esp-rtos/src/lib.rs +++ b/esp-rtos/src/lib.rs @@ -2,8 +2,10 @@ all(docsrs, not(not_really_docsrs)), doc = "
You might want to browse the esp-hal documentation on the esp-rs website instead.
The documentation here on docs.rs is built for a single chip only (ESP32-C6, in particular), while on the esp-rs website you can select your exact chip from the list of supported devices. Available peripherals and their APIs change depending on the chip.