README.markdown @ b0bcc35b016a

hg-review is still beta!  Things may break!
===========================================

Installing
==========

`hg-review` requires Mercurial 1.6+ and Python 2.5+. It requires a few other
things too, but they're bundled with the extension so you don't need to worry
about them.

First, get hg-review:

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

Then add it to your `~/.hgrc`:

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

You're all set.

Try It
======

`hg-review` uses itself for code review. If you want to get a quick taste of
how it works:

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

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

There's also a [live, read-only demo][demo] if installing is too much
committment for you.

[demo]: http://review.stevelosh.com/

Documentation
=============

Check out the [documentation][docs] to learn more.

If you've still got questions, there's a mailing list (hosted by
[Librelist][]).  Send an email (no subject/body necessary) to
[hg.review@librelist.com][ml] to subscribe.

[docs]: http://sjl.bitbucket.org/hg-review/
[Librelist]: http://librelist.com/
[ml]: mailto:hg.review@librelist.com