From 86be760e2c55db0c0e617c6e158d895e48b40ef7 Mon Sep 17 00:00:00 2001 From: jirigav Date: Sat, 25 Nov 2023 21:46:07 +0100 Subject: [PATCH] add readme --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..8a26008 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# CoolTest + +CoolTest is a randomness-testing tool. It uses first half of provided data to construct a distinguisher in a three phase process. Then it evaluates the distinguisher on the second half of the data to evaluate the probability of the data being random. + + +# How to use CoolTest + +## Setup +1. You need to have [Rust](https://www.rust-lang.org/tools/install) and Python library [SciPy](https://scipy.org/install/) installed. + + +2. Run `cargo build --release` + +## Run the tool + +You can use `./target/release/cooltest --help` to see all options. + +To run the tool with default parameters you can use: +`./target/release/cooltest ` + + + +# License +CoolTest is released under the MIT license. See See [LICENSE](LICENSE) for more information. \ No newline at end of file