Commits

Bryan O'Sullivan committed a73fad5

Fix up README

  • Participants
  • Parent commits 250d0f7

Comments (0)

Files changed (3)

README

-Criterion: robust, reliable performance measurement
----------------------------------------------------
-
-This package provides the Criterion module, a Haskell library for
-measuring and analysing the performance of Haskell programs.
-
-To get started, read the documentation for the Criterion.Main module,
-and take a look at the programs in the examples directory.
-
-
-Building and installing
------------------------
-
-To build and install criterion, just run
-
-  cabal install criterion
-
-On Mac OS X, the Chart library that criterion uses is not available,
-so you'll have to build without it.
-
-  cabal install criterion -f-chart
- 
-This will lose you the ability to generate charts, but you'll still be
-able to generate CSV files and import them into your favourite
-spreadsheet, or gnuplot, or whatnot.
-
-
-Get involved!
--------------
-
-Please feel welcome to contribute new code or bug fixes.  You can
-fetch the source repository from here:
-
-http://bitbucket.org/bos/criterion
-
-
-Authors
--------
-
-Bryan O'Sullivan <bos@serpentine.com>
+# Criterion: robust, reliable performance measurement
+
+This package provides the Criterion module, a Haskell library for
+measuring and analysing the performance of Haskell programs.
+
+To get started, read the documentation for the Criterion.Main module,
+and take a look at the programs in the examples directory.
+
+
+# Building and installing
+
+To build and install criterion, just run
+
+    cabal install criterion
+
+On Mac OS X, the Chart library that criterion uses is not available,
+so you'll have to build without it.
+
+    cabal install criterion -f-chart
+ 
+This will lose you the ability to generate charts, but you'll still be
+able to generate CSV files and import them into your favourite
+spreadsheet, or gnuplot, or whatnot.
+
+
+# Get involved!
+
+Please report bugs via the
+[bitbucket issue tracker](http://bitbucket.org/bos/criterion).
+
+Master [Mercurial repository](http://bitbucket.org/bos/criterion):
+
+* `hg clone http://bitbucket.org/bos/criterion`
+
+There's also a [git mirror](http://github.com/bos/criterion):
+
+* `git clone git://github.com/bos/criterion.git`
+
+(You can create and contribute changes using either Mercurial or git.)
+
+
+# Authors
+
+This library is written and maintained by Bryan O'Sullivan,
+<bos@serpentine.com>.
 build-type:     Simple
 cabal-version:  >= 1.6
 extra-source-files:
-  README
+  README.markdown
   examples/Fibber.hs
   examples/Judy.hs
   examples/Makefile