.. hg-review documentation master file, created by sphinx-quickstart on Mon Jun 14 20:39:45 2010. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. hg-review documentation ======================= hg-review is a `Mercurial `_ extension for performing distributed `code review `_. Quickstart ---------- If you're impatient and want to play with hg-review right away, here's what you need to do. First, clone the extension somewhere:: hg clone http://bitbucket.org/sjl/hg-review/ Then add it to your ``~/.hgrc`` file:: [extensions] review = [path to]/hg-review/review/ Now you need a repository that has code review enabled. Luckily, you've already got one -- hg-review uses itself for code review. ``cd`` into the directory you cloned hg-review to and initialize the review data, then start the web interface:: cd hg-review hg review --init hg review --web Open http://localhost:8080/ in your browser of choice and poke around. Check out the :doc:`Overview ` when you're ready to learn more. User's Guide ------------ If you want to use hg-review for anything more than some simple poking around, this is the place to start. .. toctree:: :maxdepth: 2 overview concepts webui cli Developer's Guide ----------------- If you want to integrate hg-review with your own application or Mercurial extension, or hack on hg-review itself, this is what you need to know. .. toctree:: :maxdepth: 2 api hacking licensing