README @ 789e5765c9ff

Start adding some documentation to the internals of the API.

I also managed to sneak a doctest in there which found a bug.
The bug is now fixed.
Awesome.
author Steve Losh <steve@stevelosh.com>
date Wed, 07 Oct 2009 23:38:30 -0400
parents 60a287538a94
children 82f04bfc46b8
-*- markdown -*-

This is a work in progress.  I wouldn't try it out on anything important...

Installing
==========

Get it:

    hg clone http://bitbucket.org/sjl/hg-review/

Add it to `~/.hgrc`:

    [extensions]
    review = [path to]/hg-review/review/

Unit Tests
==========

The unit tests require nose:

    pip install nose

Don't have pip?  Get it.  But if you *really* want to `easy_install`...

    easy_install nose

Run the unit tests:

    cd [path to]/hg-review
    nosetests

Progress
========

Take a look at the list of tests to see what I've got working so far:

    cd [path to]/hg-review
    nosetests -v