From ea327d194e7c3b9c49b31d7545832223c99978ab Mon Sep 17 00:00:00 2001 From: Cryptjar Date: Mon, 13 Nov 2023 21:27:04 +0100 Subject: [PATCH] Update docs. --- CHANGELOG.md | 2 +- README.md | 8 ++++---- src/lib.rs | 6 +++--- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0d20918..a422ed4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,7 +13,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 Changes since [`v0.3.3`](#033---2023-02-02). -### Changed +### BREAKING - Upgraded `ufmt` from `0.1` to `0.2` - Upgraded MSRV to `nightly-2023-08-08` diff --git a/README.md b/README.md index 4d9b83b..b9b3e44 100644 --- a/README.md +++ b/README.md @@ -22,13 +22,13 @@ compiler (as of mid 2022, inline assembly for AVR is still 'experimental'). ## MSRV -This crate works with a Rust `nightly-2022-05-10` compiler. -All versions `0.3.x` will adhere to work with `nightly-2022-05-10`. +This crate works with a Rust `nightly-2023-08-08` compiler. +All versions `0.4.x` will adhere to work with `nightly-2023-08-08`. Other Rust compiler version (particularly newer ones) might also work, but due to the use of experimental compiler features it is possible that some future Rust compiler version will fail to work. -Future versions such as `0.4.x` might required a newer Rust compiler +Future versions such as `0.5.x` might required a newer Rust compiler version. @@ -88,7 +88,7 @@ use avr_progmem::raw::read_byte; use core::ptr::addr_of; // This `static` must never be directly dereferenced/accessed! -// So a `let data: u8 = P_BYTE;` is **undefined behavior**!!! +// So a `let data: u8 = P_BYTE;` ⚠️ is **undefined behavior**!!! /// Static byte stored in progmem! #[link_section = ".progmem.data"] static P_BYTE: u8 = b'A'; diff --git a/src/lib.rs b/src/lib.rs index c677f67..dc99b17 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -38,13 +38,13 @@ //! //! ## MSRV //! -//! This crate works with a Rust `nightly-2022-05-10` compiler. -//! All versions `0.3.x` will adhere to work with `nightly-2022-05-10`. +//! This crate works with a Rust `nightly-2023-08-08` compiler. +//! All versions `0.4.x` will adhere to work with `nightly-2023-08-08`. //! Other Rust compiler version (particularly newer ones) might also work, //! but due to the use of experimental compiler features it is possible that //! some future Rust compiler version will fail to work. //! -//! Future versions such as `0.4.x` might required a newer Rust compiler +//! Future versions such as `0.5.x` might required a newer Rust compiler //! version. //! //!