Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update and simplify README #142

Open
wants to merge 9 commits into
base: v1.2-proposal
Choose a base branch
from
Open

Update and simplify README #142

Changes from 5 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
cb214ed
Update README.md
curiousleo May 25, 2020
6def341
Move Description to top
curiousleo May 25, 2020
f08d4e6
No need for code style in heading
curiousleo May 25, 2020
dd308ef
Badges to the top
curiousleo May 25, 2020
fa9b901
Remove version links
curiousleo May 25, 2020
111220e
Document explicitly as fork
curiousleo May 25, 2020
dacb044
PR -> proposal
curiousleo May 25, 2020
3124b52
Wording
curiousleo May 25, 2020
553c791
"accomodate" -> "accommodate"
curiousleo May 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 24 additions & 31 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,31 +1,24 @@
# The Haskell Standard Library

## Random Number Generation

### Status

| Language | Travis | Coveralls |
|:--------:|:------:|:---------:|
| ![GitHub top language](https://img.shields.io/github/languages/top/idontgetoutmuch/random.svg) | [![Build Status](https://secure.travis-ci.org/idontgetoutmuch/random.svg?v1.2-proposal)](http://travis-ci.org/idontgetoutmuch/random) | [![Coverage Status](https://coveralls.io/repos/github/idontgetoutmuch/random/badge.svg?branch=v1.2-proposal)](https://coveralls.io/github/idontgetoutmuch/random?branch=v1.2-proposal)

| Package | Hackage | Nightly | LTS |
|:-------------------|:-------:|:-------:|:---:|
| [`random`](https://github.com/idontgetoutmuch/random)| [![Hackage](https://img.shields.io/hackage/v/random.svg)](https://hackage.haskell.org/package/random)| [![Nightly](https://www.stackage.org/package/random/badge/nightly)](https://www.stackage.org/nightly/package/random)| [![Nightly](https://www.stackage.org/package/random/badge/lts)](https://www.stackage.org/lts/package/random)


### Description

This library provides a basic interface for (splittable) random number generators.

The API documentation can be found here:

http://hackage.haskell.org/package/random/docs/System-Random.html

A module supplying this interface is required for Haskell 98 (but not Haskell
2010). An older [version]
(http://www.haskell.org/ghc/docs/latest/html/libraries/haskell98/Random.html)
of this library is included with GHC in the haskell98 package. This newer
version, with compatible api, is included in the [Haskell Platform]
(http://www.haskell.org/platform/contents.html).

Please report bugs in the Github [issue tracker] (https://github.com/haskell/random/issues) (no longer in the GHC trac).
# random

[![Build Status](https://secure.travis-ci.org/idontgetoutmuch/random.svg?v1.2-proposal)](http://travis-ci.org/idontgetoutmuch/random)
[![Coverage Status](https://coveralls.io/repos/github/idontgetoutmuch/random/badge.svg?branch=v1.2-proposal)](https://coveralls.io/github/idontgetoutmuch/random?branch=v1.2-proposal)

**Pseudo-random number generation for Haskell.**

This library provides
- an interface for pure and optionally splittable pseudo-random number
generators: [`RandomGen`][haddock-randomgen]
- an interface for monadic pseudo-random number generators:
[`MonadRandom`][haddock-monadrandom]
- adapters to use pure pseudo-random number generators in monadic code: [see
documentation][haddock-adapters]
- a pure pseudo-random number generator implementation that is fast,
splittable, and passes empirical tests: [`StdGen`][haddock-stdgen]
curiousleo marked this conversation as resolved.
Show resolved Hide resolved

See [the documentation][haddock] for details.

[haddock]: https://htmlpreview.github.io/?https://raw.githubusercontent.com/idontgetoutmuch/random/haddock-preview/doc/index.html
[haddock-adapters]: https://htmlpreview.github.io/?https://raw.githubusercontent.com/idontgetoutmuch/random/haddock-preview/doc/System-Random-Monad.html#g:5
[haddock-monadrandom]: https://htmlpreview.github.io/?https://raw.githubusercontent.com/idontgetoutmuch/random/haddock-preview/doc/System-Random-Monad.html#t:MonadRandom
[haddock-randomgen]: https://htmlpreview.github.io/?https://raw.githubusercontent.com/idontgetoutmuch/random/haddock-preview/doc/System-Random.html#t:RandomGen
[haddock-stdgen]: https://htmlpreview.github.io/?https://raw.githubusercontent.com/idontgetoutmuch/random/haddock-preview/doc/System-Random.html#t:StdGen