Skip to content

Commit

Permalink
fix README
Browse files Browse the repository at this point in the history
  • Loading branch information
torao committed May 21, 2022
1 parent 9d253d8 commit 67d0a3e
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# TinyMT
[![github actions](https://github.com/torao/tinymt/actions/workflows/build.yml/badge.svg)](https://github.com/torao/tinymt/actions)
[![torao](https://circleci.com/gh/torao/tinymt.svg?style=svg)](https://app.circleci.com/pipelines/github/torao/tinymt)
[![docs](https://docs.rs/tinymt/badge.svg)](https://docs.rs/tinymt)

Rust implementation of TinyMT 64/32 - a lightweight variant of Mersenne Twister PRNG.

This create is based on the original [TinyMT 1.1.1](https://github.com/MersenneTwister-Lab/TinyMT) @ 9d7ca3c161
This crate is based on the original [TinyMT 1.1.1](https://github.com/MersenneTwister-Lab/TinyMT) @ 9d7ca3c161
implemented in C.

## Features
Expand All @@ -20,9 +21,9 @@ This crate provides the following two TinyMT implementations.
* TinyMT32 (32-bit version) for `u32` and `f32`. This is also defined as [RFC 8682](https://tools.ietf.org/html/rfc8682) by IEFT.
* TinyMT64 (64-bit version) for `u64` and `f64`.

TinyMT32 is also used for random numbers to control which monsters will hatch in Pokémon.
TinyMT32 has also been used for random numbers to control which monsters will hatch in Pokémon.

Note that neither TinyMT nor MT 19937 are cryptographically secure pseudo-random number generators. You shouldn't use them in applications where high security is required.
Note that neither TinyMT nor MT 19937 are cryptographically secure pseudo-random number generators. You shouldn't use them in applications where high security is required, such as the generation of private keys.

## Getting Started

Expand Down

0 comments on commit 67d0a3e

Please sign in to comment.