Skip to content

Conversation

@pitdicker
Copy link
Contributor

I looked up the pre-release of rand_core on crates.io, and found some things that could improve in the readme.

Added badges, link to changelog, removed 'primarily' from licence text, added license links, and fixed broken link to Rand.

Example rendering: https://github.com/pitdicker/rand/blob/rand_core_readme/rand_core/README.md

@pitdicker
Copy link
Contributor Author

@dhardy Forgot you also made changes to the readme of rand_core in #328 (not only rand). Do you feel like copying some of the changes from here?

@dhardy
Copy link
Member

dhardy commented Mar 25, 2018

Why not just rebase this on top of my PR?

@pitdicker
Copy link
Contributor Author

I will 😄.

@pitdicker pitdicker added the C-docs Documentation label Mar 25, 2018
@pitdicker
Copy link
Contributor Author

Do we also want to document the minimum Rust version for rand-core?
Currently it oldest version it works with is 1.16.0, but we probably want to guarantee the same version as is the minimum for Rand and on the CI, Rust 1.22.

@dhardy
Copy link
Member

dhardy commented Mar 26, 2018

You can add the minimum Rust version if you like (along with extra CI test), but I don't see much point; once for the whole Rand project should be enough since most people will use rand anyway.

Copy link
Member

@dhardy dhardy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

[![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)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we really need two doc links? Well, okay..

@pitdicker
Copy link
Contributor Author

As there is only one version of rand-core that can be used with Rand right now, the minimum Rust version of rand-core doesn't matter. I think only when someone wants to start using a newer version of rand-core with an older version of Rand the minimum version becomes a thing. I'll leave things as they are for now.

@pitdicker pitdicker merged commit 61d865f into rust-random:master Mar 26, 2018
@pitdicker pitdicker deleted the rand_core_readme branch March 26, 2018 09:53
pitdicker added a commit that referenced this pull request Apr 4, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

C-docs Documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants