criterion / README.markdown

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.

Master Mercurial repository:

  • hg clone http://bitbucket.org/bos/criterion

There's also a git mirror:

  • 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.

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.