Skip to content

Commit

Permalink
readme cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
simonmichael committed Oct 16, 2016
1 parent 27ef2d9 commit 2fb194e
Showing 1 changed file with 11 additions and 37 deletions.
48 changes: 11 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,14 @@
quickbench - quick & easy comparative benchmarking of command-line programs.
(c) Simon Michael 2008-2016

Can be used standalone as the quickbench executable, or
in haskell project benchmark suites as the QuickBench library.

This is based on the simplebench tool used in the hledger project.

Old:

Example:

$ stack install
$ quickbench --help
...
$ cat - >bench.tests
-f sample.ledger -s balance
-f ~/.ledger -s balance
$ quickbench -v hledger "ledger --no-cache" ledger
Using bench.tests
Running 2 tests 2 times in . with 3 executables at 2008-11-26 18:52:15.776357 UTC:
1: hledger -f sample.ledger -s balance [0.02s]
2: hledger -f sample.ledger -s balance [0.01s]
1: ledger --no-cache -f sample.ledger -s balance [0.02s]
2: ledger --no-cache -f sample.ledger -s balance [0.02s]
1: ledger -f sample.ledger -s balance [0.02s]
2: ledger -f sample.ledger -s balance [0.02s]
1: hledger -f ~/.ledger -s balance [3.56s]
2: hledger -f ~/.ledger -s balance [3.56s]
1: ledger --no-cache -f ~/.ledger -s balance [0.10s]
2: ledger --no-cache -f ~/.ledger -s balance [0.10s]
1: ledger -f ~/.ledger -s balance [0.10s]
2: ledger -f ~/.ledger -s balance [0.10s]

Summary (best iteration):

|| hledger | ledger --no-cache | ledger
============================++=========+===================+=======
-f sample.ledger -s balance || 0.01 | 0.02 | 0.02
-f ~/.ledger -s balance || 3.56 | 0.10 | 0.10
This is a cleaned up successor to the simplebench benchmarking tool
from the hledger project. It can be used for general command-line
benchmarking (quickbench) or as a haskell library (QuickBench).
It is not smart or complicated like "bench" or criterion; it is
good for quick and dirty, exploratory, comparative measurements
that you can understand at a glance.

$ git clone https://github.com/simonmichael/quickbench.git
$ stack install ./quickbench
# ensure $PATH includes ~/.local/bin
$ quickbench -h

0 comments on commit 2fb194e

Please sign in to comment.