33Quick & easy benchmarking of command-line programs.
44
55 [ About] ( #about )
6+ | [ Install] ( #install )
67| [ Examples] ( #examples )
7- | [ Usage ] ( #usage )
8- | [ Related] ( #related-work )
8+ | [ Options ] ( #options )
9+ | [ Related tools ] ( #related-tools )
910
1011
1112## About
@@ -21,17 +22,24 @@ and tabulates results from multiple executables.
2122I find it very useful for quick and dirty, exploratory, and comparative measurements
2223that you can understand at a glance.
2324
24- ## Examples
25+ ## Install
2526
26- Install it easily on most platforms with [ stack] ( https://haskell-lang.org/get-started ) (or cabal).
27- It's not yet on Hackage, so you'll need the source:
27+ You can build it from source on most platforms supporting [ GHC] ( https://haskell.org/ghc ) .
28+ A [ patch] ( https://github.com/docopt/docopt.hs/pull/34 ) is required for one of the dependencies,
29+ so for now you must build quickbench from inside its source tree, with
30+ [ stack] ( https://www.fpcomplete.com/haskell/get-started/ )
31+ (or if you build with [ cabal] ( https://cabal.readthedocs.io ) , ensure it uses the docopt version mentioned in stack.yaml):
2832
2933```
3034$ git clone https://github.com/simonmichael/quickbench
3135$ cd quickbench
32- $ stack install # ensure $PATH includes ~/.local/bin
36+ $ stack install
3337```
3438
39+ stack will advise you to add ~ /.local/bin to $PATH if needed.
40+
41+ ## Examples
42+
3543You can specify test commands as arguments:
3644```
3745$ quickbench 'sleep 1'
@@ -139,7 +147,7 @@ Best times:
139147+-----------------------------------++--------------------+---------------------+
140148```
141149
142- ## Usage
150+ ## Options
143151
144152```
145153$ quickbench -h
@@ -167,7 +175,7 @@ Options:
167175 -h, --help show this help
168176```
169177
170- ## Related
178+ ## Related tools
171179
172180[ bench] ( https://github.com/Gabriel439/bench#readme ) (Gabriel Gonzalez 2016) is another
173181command line benchmarking tool written in Haskell.
0 commit comments