Skip to content

Commit

Permalink
edit readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jirigav committed Apr 3, 2024
1 parent e092289 commit f3669cf
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 4 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# 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.
CoolTest is a randomness-testing tool. It uses first half of provided data to construct a distinguisher based on a histogram construction. Then it evaluates the distinguisher on the second half of the data to evaluate the probability of the data being generated by true random number generator.


# 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.
1. You need to have [Rust](https://www.rust-lang.org/tools/install) and Python library [SciPy](https://scipy.org/install/) (version 1.7.0 or newer) installed.


2. Run `cargo build --release`
Expand All @@ -21,4 +21,4 @@ To run the tool with default parameters you can use:


# License
CoolTest is released under the MIT license. See See [LICENSE](LICENSE) for more information.
CoolTest is released under the MIT license. See [LICENSE](LICENSE) for more information.
1 change: 0 additions & 1 deletion src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ use clap::Parser;
use common::prepare_data;
use std::time::Instant;


fn print_results(p_value: f64, z_score: f64, alpha: f64) {
println!("----------------------------------------------------------------------");
println!("RESULTS:");
Expand Down

0 comments on commit f3669cf

Please sign in to comment.