Add README

This commit is contained in:
David Peter 2018-01-13 20:27:24 +01:00 committed by GitHub
parent 68fdc2c6fc
commit f8cbb339d2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

21
README.md Normal file
View File

@ -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.