README @ c428b0634fd7 webui

-*- markdown -*-

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

You can look at some [screenshots](http://www.flickr.com/photos/sjl7678/sets/72157622593551064/), but be warned that they might be a little out of date!

Installing
==========

`hg-review` requires Mercurial (probably 1.3.1+) and **Python 2.6+**.  Seriously, you need the latest version of Python.  I'm not going to rewrite `os.relpath()` to support older versions, sorry.

Get it:

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

Add it to `~/.hgrc`:

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

Try It
======

`hg-review` uses itself for code review.

I know, I know, it's so goddamn meta I think the internet might explode.

If you want to get a quick taste of how it works:

    cd path/to/wherever/you/cloned/hg-review
    hg update webui
    hg review --init
    hg review --web

Now visit <http://localhost:8080/> and have fun.  Use `^C` to kill the server when you're done.

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