Skip to content

Commit 50f8736

Browse files
authored
Merge pull request #294 from dhardy/policies
Update readme: rustc version policy
2 parents d59be88 + 08e86fb commit 50f8736

File tree

1 file changed

+23
-12
lines changed

1 file changed

+23
-12
lines changed

README.md

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
rand
1+
Rand
22
====
33

44
A Rust library for random number generators and other randomness functionality.
@@ -23,15 +23,26 @@ and this to your crate root:
2323
extern crate rand;
2424
```
2525

26-
### Versions and Rustc requirements
26+
## Versions
2727

28-
Version `0.4`was released in December 2017. It contains almost no breaking
29-
changes since the `0.3` series, but nevertheless contains some significant
30-
new code, including a new "external" entropy source (`JitterRng`) and `no_std`
31-
support. Both 0.3 and 0.4 require **Rustc version 1.15 or greater**.
28+
Version 0.5 is in development and contains many breaking changes; expected
29+
release date is approx. end of March 2018 if all goes well.
3230

33-
Version `0.5` is in development and will contain significant breaking changes.
34-
It requires **Rustc version 1.22 or greater**.
31+
Version 0.4 was released in December 2017. It contains almost no breaking
32+
changes since the 0.3 series.
33+
34+
For more details, see the [changelog](CHANGELOG.md).
35+
36+
### Rust version requirements
37+
38+
The 0.5 release of Rand will require **Rustc version 1.22 or greater**.
39+
Rand 0.4 and 0.3 (since approx. June 2017) require Rustc version 1.15 or
40+
greater. Subsets of the Rand code may work with older Rust versions, but this
41+
is not supported.
42+
43+
Travis CI always has a build with a pinned version of Rustc matching the oldest
44+
supported Rust release. The current policy is that this can be updated in any
45+
Rand release if required, but the change must be noted in the changelog.
3546

3647
## Examples
3748

@@ -62,7 +73,7 @@ println!("i32: {}, u32: {}", rng.gen::<i32>(), rng.gen::<u32>())
6273

6374
## Features
6475

65-
By default, `rand` is built with all stable features available. The following
76+
By default, Rand is built with all stable features available. The following
6677
optional features are available:
6778

6879
- `alloc` can be used instead of `std` to provide `Vec` and `Box`
@@ -88,7 +99,7 @@ Unfortunately, `cargo test` does not test everything. The following tests are
8899
recommended:
89100

90101
```
91-
# Basic tests for rand and sub-crates
102+
# Basic tests for Rand and sub-crates
92103
cargo test --all
93104
94105
# Test no_std support
@@ -111,7 +122,7 @@ cargo test --benches
111122

112123
# License
113124

114-
`rand` is primarily distributed under the terms of both the MIT
125+
Rand is distributed under the terms of both the MIT
115126
license and the Apache License (Version 2.0).
116127

117-
See LICENSE-APACHE, and LICENSE-MIT for details.
128+
See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT) for details.

0 commit comments

Comments
 (0)