From 8e89d51a861d8d382691f5bc4bbd3a29d089f96e Mon Sep 17 00:00:00 2001 From: Paul Dicker Date: Sun, 25 Mar 2018 09:27:25 +0200 Subject: [PATCH 1/4] Changes to rand_core readme --- rand_core/README.md | 27 ++++++++++++++++++--------- 1 file changed, 18 insertions(+), 9 deletions(-) diff --git a/rand_core/README.md b/rand_core/README.md index 1f355145084..3a9354828c7 100644 --- a/rand_core/README.md +++ b/rand_core/README.md @@ -1,5 +1,9 @@ -rand_core -==== +# rand_core + +[![Build Status](https://travis-ci.org/rust-lang-nursery/rand.svg)](https://travis-ci.org/rust-lang-nursery/rand) +[![Build Status](https://ci.appveyor.com/api/projects/status/github/rust-lang-nursery/rand?svg=true)](https://ci.appveyor.com/project/alexcrichton/rand) +[![crates.io](https://img.shields.io/crates/v/rand_core.svg)](https://crates.io/crates/rand_core) +[![docs.rs](https://docs.rs/rand_core/badge.svg)](https://docs.rs/rand_core) Core traits and error types of the [rand] library, plus tools for implementing RNGs. @@ -14,7 +18,11 @@ applications (including sampling from restricted ranges, conversion to floating point, list permutations and secure initialisation of RNGs). Most users should prefer to use the main [rand] crate. -[Documentation](https://docs.rs/rand_core) +Documentation: +[master branch](https://rust-lang-nursery.github.io/rand/rand_core/index.html), +[by release](https://docs.rs/rand_core) + +[Changelog](CHANGELOG.md) [rand]: https://crates.io/crates/rand @@ -36,14 +44,15 @@ The traits and error types are also available via `rand`. comprising `RngCore` support for `Box` types where `R: RngCore`, as well as extensions to the `Error` type's functionality. -Due to a bug in Cargo, `rand_core` is built without `std` support by default. -Since features are unioned across the whole dependency tree, any crate using -`rand` with its default features will also enable `std` support in `rand_core`. +Due to [rust-lang/cargo#1596](https://github.com/rust-lang/cargo/issues/1596), +`rand_core` is built without `std` support by default. Since features are +unioned across the whole dependency tree, any crate using `rand` with its +default features will also enable `std` support in `rand_core`. # License -`rand` is primarily distributed under the terms of both the MIT -license and the Apache License (Version 2.0). +`rand_core` is distributed under the terms of both the MIT license and the +Apache License (Version 2.0). -See LICENSE-APACHE, and LICENSE-MIT for details. +See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT) for details. From 50f3837e21009fe3a88e385fae6697e94d6fa73d Mon Sep 17 00:00:00 2001 From: Paul Dicker Date: Sun, 25 Mar 2018 10:29:41 +0200 Subject: [PATCH 2/4] Add badges for crates.io --- Cargo.toml | 4 ++++ rand_core/Cargo.toml | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/Cargo.toml b/Cargo.toml index 371a596fd87..27a768b7b15 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -13,6 +13,10 @@ Random number generators and other randomness functionality. keywords = ["random", "rng"] categories = ["algorithms"] +[badges] +travis-ci = { repository = "rust-lang-nursery/rand" } +appveyor = { repository = "alexcrichton/rand" } + [features] default = ["std"] nightly = ["i128_support"] # enables all features requiring nightly rust diff --git a/rand_core/Cargo.toml b/rand_core/Cargo.toml index 57cf5e3c080..3987b150b60 100644 --- a/rand_core/Cargo.toml +++ b/rand_core/Cargo.toml @@ -13,6 +13,10 @@ Core random number generator traits and tools for implementation. keywords = ["random", "rng"] categories = ["algorithms"] +[badges] +travis-ci = { repository = "rust-lang-nursery/rand" } +appveyor = { repository = "alexcrichton/rand" } + [features] # Bug: https://github.com/rust-lang/cargo/issues/4361 # default = ["std"] From 910a372944d70e01cd5f338fd732956a0d7c94cb Mon Sep 17 00:00:00 2001 From: Paul Dicker Date: Sun, 25 Mar 2018 10:40:31 +0200 Subject: [PATCH 3/4] Add more badges to Readme.md --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index bdd8a6c89f5..311f8c3436e 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ -Rand -==== +# Rand + +[![Build Status](https://travis-ci.org/rust-lang-nursery/rand.svg?branch=master)](https://travis-ci.org/rust-lang-nursery/rand) +[![Build Status](https://ci.appveyor.com/api/projects/status/github/rust-lang-nursery/rand?svg=true)](https://ci.appveyor.com/project/alexcrichton/rand) +[![crates.io](https://img.shields.io/crates/v/rand.svg)](https://crates.io/crates/rand) +[![docs.rs](https://docs.rs/rand/badge.svg)](https://docs.rs/rand) A Rust library for random number generators and other randomness functionality. @@ -7,9 +11,6 @@ See also: * [rand_core](https://crates.io/crates/rand_core) -[![Build Status](https://travis-ci.org/rust-lang-nursery/rand.svg?branch=master)](https://travis-ci.org/rust-lang-nursery/rand) -[![Build status](https://ci.appveyor.com/api/projects/status/rm5c9o33k3jhchbw?svg=true)](https://ci.appveyor.com/project/alexcrichton/rand) - Documentation: [master branch](https://rust-lang-nursery.github.io/rand/rand/index.html), [by release](https://docs.rs/rand) From 4788a0e9979b7df0be8c840c5765370c40fa9092 Mon Sep 17 00:00:00 2001 From: Paul Dicker Date: Sun, 25 Mar 2018 10:48:56 +0200 Subject: [PATCH 4/4] Add no_std category for crates.io --- Cargo.toml | 2 +- rand_core/Cargo.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Cargo.toml b/Cargo.toml index 27a768b7b15..ab4a03cc308 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -11,7 +11,7 @@ description = """ Random number generators and other randomness functionality. """ keywords = ["random", "rng"] -categories = ["algorithms"] +categories = ["algorithms", "no_std"] [badges] travis-ci = { repository = "rust-lang-nursery/rand" } diff --git a/rand_core/Cargo.toml b/rand_core/Cargo.toml index 3987b150b60..f052c8720d2 100644 --- a/rand_core/Cargo.toml +++ b/rand_core/Cargo.toml @@ -11,7 +11,7 @@ description = """ Core random number generator traits and tools for implementation. """ keywords = ["random", "rng"] -categories = ["algorithms"] +categories = ["algorithms", "no_std"] [badges] travis-ci = { repository = "rust-lang-nursery/rand" }