# XD lol

[![Crates.io](https://img.shields.io/crates/v/xdlol.svg)](https://crates.io/crates/xdlol) [![Crates.io](https://img.shields.io/crates/d/xdlol.svg)](https://crates.io/crates/xdlol) [![license](https://img.shields.io/crates/l/xdlol.svg)](https://gitlab.com/starshell/xdlol/blob/master/LICENSE) [![Coverage Status](https://codecov.io/gl/starshell/xdlol/branch/master/graph/badge.svg)](https://codecov.io/gl/starshell/xdlol)

Linux: [![Build status](https://gitlab.com/starshell/xdlol/badges/master/pipeline.svg)](https://gitlab.com/starshell/xdlol/commits/master)
Windows: [![Build status](https://ci.appveyor.com/api/projects/status/k7ccce79080tfu18/branch/master?svg=true)](https://ci.appveyor.com/project/Eudoxier/xdlol/branch/master)

 

---

> **THIS LIBRARY IS NOT READY FOR USE IN PRODUCTION OR WITH ANYTHING THAT NEEDS TO BE SECURE**
>
> If you need something to test randomness unfortunately I am not aware of any existing library for unit-testing or Rust specifically. Take a look at either [Dieharder](https://webhome.phy.duke.edu/%7Ergb/General/dieharder.php) or [ENT](http://fourmilab.ch/random/).

I am only pushing to crates.io now to easily include it in my project it is intended to be used in easily, and to test the API as it is developed in it.

---

 

Randomness tests.

> XD lol, it is what people type when they think they are being random.

For testing sequences of bytes in unit tests or stored in files and producing reports of the results. It is useful for evaluating pseudorandom number generators for encryption and statistical sampling applications, compression algorithms, and other applications.

## Usage

Add `xdlol` as a dependency in your `Cargo.toml` to use from crates.io:

```toml
[dependencies]
xdlol = "0.0.0"
```

Then add `extern crate xdlol;` to your crate root and run `cargo build` or `cargo update && cargo build` for your project. Detailed documentation for releases can be found on [docs.rs](https://docs.rs/xdlol/) and the bleeding edge docs for the latest GitLab repository version can be found on [GitLab pages](http://starshell.gitlab.io/xdlol/xdlol/).

### Example

```rust
extern crate xdlol;
use xdlol;
```

Examples can also be ran directly:

```sh
$ cargo run --example yes_no_with_defaults
    Finished dev [unoptimized + debuginfo] target(s) in 0.0 secs
     Running `target/debug/examples/yes_no_with_defaults`
```

See [examples](examples/) for more.

## Contributing

The project is mirrored to GitHub, but all development is done on GitLab. Please use the [GitLab issue tracker](https://gitlab.com/starshell/xdlol/issues). Don't have a GitLab account? Just email `incoming+starshell/xdlol@gitlab.com` and those emails automatically become issues (with the comments becoming the email conversation).

To contribute to xdlol, please see [CONTRIBUTING](CONTRIBUTING.md).

## License

xdlol is distributed under the terms of the MPL 2.0 license. If this does not suit your needs for some reason please feel free to contact me, or open an issue.

See [LICENSE](LICENSE).