Skip to content

Commit

Permalink
Update docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
Cryptjar committed Nov 13, 2023
1 parent 24896c0 commit ea327d1
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.


Expand Down Expand Up @@ -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';
Expand Down
6 changes: 3 additions & 3 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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.
//!
//!
Expand Down

0 comments on commit ea327d1

Please sign in to comment.