initial import

1 files changed, 57 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..28a9325
--- /dev/null
+++ b/README.md
@@ -0,0 +1,57 @@
+# ministat
+A small tool to do the statistics legwork on benchmarks etc.
+
+Written by Poul-Henning Kamp, lured into a dark Linux alley and clubbed over the head and hauled away to Github by yours truly.
+
+## Build & Install
+
+There should be no dependencies besides the standard libraries and a functional tool-chain.
+
+	$ cd ministat/
+	$ make
+	# INSTALLPATH=/usr/bin make install
+
+## Usage
+The FreeBSD man page is very relevant, pursue it [here](http://www.freebsd.org/cgi/man.cgi?ministat).
+
+	Usage: ministat [-C column] [-c confidence] [-d delimiter(s)] [-ns] [-w width] [file [file ...]]
+		confidence = {80%, 90%, 95%, 98%, 99%, 99.5%}
+		-C : column number to extract (starts and defaults to 1)
+		-d : delimiter(s) string, default to " \t"
+		-n : print summary statistics only, no graph/test
+		-s : print avg/median/stddev bars on separate lines
+		-w : width of graph/test output (default 74 or terminal width)
+
+## Example
+From the FreeBSD [man page](http://www.freebsd.org/cgi/man.cgi?ministat)
+
+	$ cat << EOF > iguana
+	50
+	200
+	150
+	400
+	750
+	400
+	150
+	EOF
+
+	$ cat << EOF > chameleon
+	150
+	400
+	720	
+	500
+	930
+	EOF
+
+	$ ministat -s -w 60 iguana chameleon
+	x iguana
+	+ chameleon
+	+------------------------------------------------------------+
+	|x      *  x	     *	       +	   + x	            +|
+	| |________M______A_______________|			     |
+	| 	      |________________M__A___________________|      |
+	+------------------------------------------------------------+
+	    N	  Min	     Max     Median	   Avg	     Stddev
+	x   7	   50	     750	200	   300	  238.04761
+	+   5	  150	     930	500	   540	  299.08193
+	No difference proven at 95.0% confidence