Skip to content

Commit

Permalink
refactor!: change MSRV to be latest stable Rust release
Browse files Browse the repository at this point in the history
  • Loading branch information
GregoryConrad committed Sep 5, 2024
1 parent 094d1d9 commit 339de09
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ jobs:
strategy:
matrix:
os: ["ubuntu-latest", "macos-latest", "windows-latest"]
toolchain: ["1.75.0", "nightly"]
toolchain: ["stable", "nightly"]

runs-on: ${{ matrix.os }}

Expand Down
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,15 @@ assert_eq!(count, 1);
assert_eq!(count_plus_one, 2);
```

> [!NOTE]
> The syntax used in the example above requires nightly for `unboxed_closures` and `fn_traits`,
> which is feature-gated under the `experimental-api` feature.
> Once `unboxed_closures` and `fn_traits` stabilize,
> this nightly syntax will be the preferred syntax,
> and this will no longer be feature-gated.
> (Without nightly, you must instead call the slightly more verbose
> `get.as_ref(some_capsule).clone()` and `register.register(effect())`.)

## Getting Started
Simply run:
Expand All @@ -92,16 +101,8 @@ Also, there is some WIP [documentation] that will help you learn the core concep


## Minimum Supported Rust Version (MSRV)
The MSRV of `rearch` is currently 1.75.0 and may change in any new ReArch version/release.
The MSRV of other crates in this repo will be the latest stable release for the foreseeable future.

It is also worth mentioning that the example shown in "In a Nutshell" above requires nightly
for `unboxed_closures` and `fn_traits`, which is feature-gated under the `experimental-api` feature.
Once `unboxed_closures` and `fn_traits` stabilize,
this nightly syntax will be the preferred syntax,
and this will no longer be feature-gated.
(Without nightly, you must instead call the slightly more verbose
`get.as_ref(some_capsule).clone()` and `register.register(effect())`.)
The MSRV is the current stable Rust version for all crates in this repo.
As such, any new release may require an updated Rust installation.


## Help Wanted!
Expand Down
1 change: 0 additions & 1 deletion rearch/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
name = "rearch"
version = "0.10.2"
documentation = "https://docs.rs/rearch"
rust-version = "1.75"
edition.workspace = true
license.workspace = true
description.workspace = true
Expand Down

0 comments on commit 339de09

Please sign in to comment.