Skip to content

Commit

Permalink
add README, update licensing info
Browse files Browse the repository at this point in the history
  • Loading branch information
joseluis committed Aug 10, 2023
1 parent b74fee8 commit b66ba3b
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 2 deletions.
1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ documentation = "https://docs.rs/alazar"
license = "MIT OR Apache-2.0"
include = [
"/src/**/*.rs",
"/src/**/*.md",
"/Cargo.toml",
"/LICENSE-*",
"/README.md",
Expand Down
46 changes: 46 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# alazar

[![Crate](https://img.shields.io/crates/v/alazar.svg)](https://crates.io/crates/alazar)
[![API](https://docs.rs/alazar/badge.svg)](https://docs.rs/alazar/)
[![MSRV: 1.64.0](https://flat.badgen.net/badge/MSRV/1.64.0/purple)](https://releases.rs/docs/1.64.0/)

Random number generation.

See [the documentation](https://docs.rs/alazar/) for more information.

## Status

This is currently in an experimental stage of development.

## License
This project is dual licensed under either [MIT](LICENSE-MIT)
or [Apache-2.0](LICENSE-APACHE) at your option.

### Derived Works

This project includes the following derived works:
- [`Mult13P1`] is based on code from B. J. Murphy for the RCA1802,
published in [Byte Magazine][0] in nov 1977.
- [`Xabc`] is based on code from user *EternityForest*, published in
[Electro-Tech-Online.com][1] in dec 2011.
- [`Xyza8a`] and [`Xyza8b`] are based on code from Edward Rosten,
published in [8bit_rng][2], licensed as [BSD-2][2L].

[`Mult13P1`]: https://docs.rs/devela/latest/alazar/misc/strut.Mult13P1.html
[0]: https://archive.org/details/BYTE_Vol_02-11_1977-11_Sweet_16/page/n219/
[`Xabc`]: https://docs.rs/devela/latest/alazar/misc/strut.Xabc.html
[1]: https://www.electro-tech-online.com/threads/ultra-fast-pseudorandom-number-generator-for-8-bit.124249/
[`Xyza8a`]: https://docs.rs/devela/latest/alazar/xorshift/strut.Xyza8a.html
[`Xyza8b`]: https://docs.rs/devela/latest/alazar/xorshift/strut.Xyza8b.html
[2]: https://github.com/edrosten/8bit_rng
[2L]: https://github.com/andamira/alazar/blob/main/src/xorshift/xyza8/LICENSE-BSD2.md

## Contributing

Contributions are welcomed to help refine and improve this library over time.
If you notice a bug, have an idea for a new feature, or simply want to
suggest improvements to the existing codebase, please get in touch.

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by shall be dual licensed as above,
without any additional terms or conditions.
3 changes: 1 addition & 2 deletions src/xorshift/xyza8/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
///
/// # License
/// This algorithm was ported from [8bit_rng](https://github.com/edrosten/8bit_rng).
/// Copyright (c) 2008--2013 Edward Rosten.
/// Copyright (c) 2008-2013 Edward Rosten.
/// Licensed under the [BSD 2-Clause "Simplified" License][license]
///
/// [license]: https://github.com/edrosten/8bit_rng/blob/master/LICENSE
Expand Down Expand Up @@ -59,7 +59,6 @@ impl Xyza8a {
/// random number tests.
///
/// Its longest cycle is 4,294,967,294.
///
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct Xyza8b {
x: u8,
Expand Down

0 comments on commit b66ba3b

Please sign in to comment.