Skip to content

Commit

Permalink
readme headings, less bash highlighting
Browse files Browse the repository at this point in the history
  • Loading branch information
simonmichael committed Oct 17, 2016
1 parent 1a14513 commit cb4fae3
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Quick & easy benchmarking of command-line programs.

## About

This is a reboot of the simplebench benchmarking tool from the hledger
project. You can use it as a fancier "time" command for benchmarking
command-line programs, or as a haskell library (eg in package benchmark
Expand All @@ -12,6 +14,8 @@ good for quick and dirty, exploratory, comparative measurements
that you can run quickly and understand at a glance.
I find it very useful; patches welcome!

## Examples

```bash
$ git clone https://github.com/simonmichael/quickbench.git
$ cd quickbench
Expand All @@ -32,7 +36,7 @@ Best times:
```

or in a file.. `bench.sh` will be used by default:
```bash
```
$ echo 'echo 3 * 1000000' > bench.sh
$ quickbench
Running 1 tests 1 times at 2016-10-16 23:53:04.743899 UTC:
Expand All @@ -46,7 +50,7 @@ Best times:
```

You can compare results with different executables:
```bash
```
$ quickbench -w echo,expr -p5
Running 1 tests 1 times with 2 executables at 2016-10-16 23:56:40.808703 UTC:
Expand All @@ -59,7 +63,7 @@ Best times:
```

and repeat tests to reduce and evaluate jitter:
```bash
```
$ quickbench -w echo,expr -p5 -n100 -N2
Running 1 tests 100 times with 2 executables at 2016-10-16 23:57:34.387764 UTC:
Expand All @@ -79,7 +83,7 @@ Best times 2:
```

You can turn a shell script into a benchmark suite by adding a shebang line:
```bash
```
$ cat 410-run-time.sh
#!/usr/bin/env quickbench -v -p2 -n2 -w hledger-410-before,hledger-410-8bde75c -f
hledger -f 10000x1000x10.journal print
Expand Down Expand Up @@ -123,8 +127,9 @@ Best times:
+-----------------------------------++--------------------+---------------------+
```

Usage:
```bash
## Usage

```
$ quickbench -h
quickbench 1.0
Run some test commands, possibly with different executables, once or more
Expand Down

0 comments on commit cb4fae3

Please sign in to comment.