micro_rand/lib.rs
1#![no_std]
2
3/*!
4# 🎲 micro_rand
5
6A tiny, no STD library for generating (pseudo) random numbers.
7
8## 💠Install
9
10Just add the following to your `Cargo.toml`:
11
12```toml
13[dependencies]
14micro_rand = "0.0.1"
15```
16
17## 📄 Info
18
19Uses the Linear congruential generator algorithm to generate pseudo random numbers. You must supply a seed value in the form of a `i64` integer.
20
21## 💥 Examples
22Super Simple Example
23```rust
24// Import Lib
25use micro_rand::*;
26
27// Create a new random generator with seed 1234
28let mut rnd = Random::new(1234);
29
30// Generate a Number!
31let num1 = rnd.next_f64();
32
33// Generate an int between two values
34let num2 = rnd.next_int_i64(0, 100);
35```
36!*/
37
38mod random;
39pub use random::Random;