Skip to content

Commit 48d26fb

Browse files
committed
doc updates
1 parent 7a5dc67 commit 48d26fb

File tree

3 files changed

+20
-9
lines changed

3 files changed

+20
-9
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,24 +10,24 @@ Quick & easy benchmarking of command-line programs.
1010

1111
## About
1212

13-
quickbench is an update and repackaging of a benchmarking tool I've been
13+
quickbench is an update and repackaging of a little benchmarking tool I've been
1414
using in the hledger project since 2008.
15-
Use it like a more powerful "time" command for benchmarking general command-line programs,
15+
Use it like a more powerful "time" command for measuring the time taken by command-line programs,
1616
or for creating repeatable benchmark scripts for your projects.
1717

1818
quickbench produces very simple output (elapsed seconds),
1919
as quickly as possible (running commands just once by default),
2020
and tabulates results from multiple executables.
2121
I find it very useful for quick and dirty, exploratory, and comparative measurements
22-
that I (and others) can understand at a glance.
22+
that you can understand at a glance.
2323

2424
## Examples
2525

2626
Install it easily on most platforms with [stack](https://haskell-lang.org/get-started) (or cabal).
2727
It's not yet on Hackage, so you'll need the source:
2828

2929
```
30-
$ git clone https://github.com/simonmichael/quickbench.git
30+
$ git clone https://github.com/simonmichael/quickbench
3131
$ cd quickbench
3232
$ stack install # ensure $PATH includes ~/.local/bin
3333
```
@@ -74,7 +74,7 @@ Best times:
7474
```
7575

7676
and run tests repeatedly to reduce or observe jitter.
77-
(quickbench assumes the quickest measurement is the truest one):
77+
quickbench assumes the quickest measurement is the truest one:
7878
```
7979
$ quickbench -w echo,expr -p5 -n100 -N2
8080
Running 1 tests 100 times with 2 executables at 2016-10-16 23:57:34.387764 UTC:

quickbench.1

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,17 @@ quickbench \- quick & easy benchmarking of command\-line programs
1010
\f[C]quickbench\ [options]\ [<cmd>...]\f[]
1111
.SH DESCRIPTION
1212
.PP
13-
Runs some test commands, possibly with different executables, once or
14-
more and shows their best execution times in tabular format.
13+
quickbench runs some test commands, possibly with different executables,
14+
once or more and shows their best execution times in tabular format.
15+
.PP
16+
It produces very simple output (elapsed seconds), as quickly as possible
17+
(running commands just once by default), and tabulates results from
18+
multiple executables.
19+
I find it useful for quick and dirty, exploratory, and comparative
20+
.PD 0
21+
.P
22+
.PD
23+
measurements that you (and others) can understand at a glance.
1524
.PP
1625
Commands are specified as one or more quote\-enclosed arguments, and/or
1726
one per line in CMDSFILE; or read from a default file [./bench.sh].
@@ -119,9 +128,11 @@ easier.
119128
https://github.com/simonmichael/quickbench/issues
120129
.SH SEE ALSO
121130
.PP
122-
Home: https://github.com/simonmichael/quickbench
131+
Home page: https://github.com/simonmichael/quickbench
123132
.PP
124133
bench(1): https://github.com/Gabriel439/bench
134+
.PP
135+
time(1)
125136
.SH COPYRIGHT
126137
.PP
127138
Copyright (C) 2008\-2016 Simon Michael.

quickbench.1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ https://github.com/simonmichael/quickbench/issues
108108

109109
# SEE ALSO
110110

111-
Home: https://github.com/simonmichael/quickbench
111+
Home page: https://github.com/simonmichael/quickbench
112112

113113
bench(1): https://github.com/Gabriel439/bench
114114

0 commit comments

Comments
 (0)