Skip to content

Commit

Permalink
Alter stability note in README and briefly explain unstable feature
Browse files Browse the repository at this point in the history
  • Loading branch information
JurajSadel committed Jan 6, 2025
1 parent 39da533 commit 5e26d33
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ If you have any questions, comments, or concerns, please [open an issue], [start

> [!NOTE]
>
> This project is still in the relatively early stages of development, and as such there should be no expectation of API stability. A significant number of peripherals currently have drivers implemented but have varying levels of functionality. For most tasks, this should be usable already, however some more advanced or uncommon features may not yet be implemented.
> This project is still in the relatively early stages of development. A significant number of peripherals currently have drivers implemented but have varying levels of functionality. For most tasks, this should be usable already, however some more advanced or uncommon features may not yet be implemented.
[esp-lp-hal]: https://github.com/esp-rs/esp-hal/tree/main/esp-lp-hal
[esp-idf-svc]: https://github.com/esp-rs/esp-idf-svc
Expand Down
6 changes: 6 additions & 0 deletions esp-hal/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,12 @@ For help getting started with this HAL, please refer to [The Rust on ESP Book] a
[s2-trm]: https://www.espressif.com/sites/default/files/documentation/esp32-s2_technical_reference_manual_en.pdf
[s3-trm]: https://www.espressif.com/sites/default/files/documentation/esp32-s3_technical_reference_manual_en.pdf

## `unstable` feature

We aim to avoid enabling experimental features automatically. Allowing automatic access could result in users unintentionally utilizing APIs that are still under development.

This feature is **NOT** enabled by default.

## Minimum Supported Rust Version (MSRV)

This crate is guaranteed to compile on stable Rust 1.83 and up. It _might_
Expand Down

0 comments on commit 5e26d33

Please sign in to comment.