From f8cbb339d2a22c9d6082559e836bfafddf4ba4ea Mon Sep 17 00:00:00 2001 From: David Peter Date: Sat, 13 Jan 2018 20:27:24 +0100 Subject: [PATCH] Add README --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..b63e5e0 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# hyperfine + +A command-line benchmarking tool (inspired by [bench](https://github.com/Gabriel439/bench)). + +Usage: +``` bash +> hyperfine 'sleep 0.3' 'sleep 1.7' +``` + +## Features + +* Statistical analysis across multiple runs. +* Support for arbitrary shell commands- +* Visual indication of the benchmark progress. +* Warmup runs that are executed before the actual benchmark. + +## Origin of the name + +The name *hyperfine* was chosen in reference to the hyperfine levels of caesium 133 which play a crucial role in the +[definition of our base unit of time](https://en.wikipedia.org/wiki/Second#Based_on_caesium_microwave_atomic_clock) +— the second.