From 95541183efe29471d76fb11d86121de7ef52a1fb Mon Sep 17 00:00:00 2001 From: J / Jacob Babich Date: Mon, 30 Sep 2024 15:30:44 -0400 Subject: [PATCH] docs: explain MSRV policy --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 86e2c45..ffca137 100644 --- a/README.md +++ b/README.md @@ -17,3 +17,7 @@ cli-clap --> multibinary gui-eframe --> multibinary tui-ratatui --> multibinary ``` + +## Versioning + +All the crates in this project have a [minimum supported Rust version (MSRV)](https://rust-lang.github.io/rfcs/2495-min-rust-version.html) of 1.76, the release succeeding [the one that stabilized `async fn` in traits](https://blog.rust-lang.org/2023/12/28/Rust-1.75.0.html) (which the `core` crate of this project is expected to make use of). I intend to test this in CI (GitHub Actions) in the future to identify if it ever gets raised by changes but I have not set this up yet. Raising the MSRV will be considered a breaking change --- my justification is that it [seems more appropriate for an application like this](https://github.com/matklad/once_cell/issues/201#issuecomment-1257213601). This may be reconsidered if [Cargo's MSRV-aware resolver](https://rust-lang.github.io/rfcs/3537-msrv-resolver.html) is stabilized.