# HG changeset patch # User Steve Losh # Date 1276564156 14400 # Node ID 5d26872c026084b83cf29b8f42db422c49ffaf47 # Parent 480c971af727a4c5234b0dafef90204341582440 docs: add more structure to the skeleton diff -r 480c971af727 -r 5d26872c0260 docs/cli.rst --- a/docs/cli.rst Mon Jun 14 20:55:51 2010 -0400 +++ b/docs/cli.rst Mon Jun 14 21:09:16 2010 -0400 @@ -0,0 +1,19 @@ +Command Line Interface +====================== + +hg-review provides a command line interface. + +review +------ + +``--comment`` +------------- + +``--signoff`` +------------- + +``--check`` +----------- + +``--web`` +--------- diff -r 480c971af727 -r 5d26872c0260 docs/dev.rst diff -r 480c971af727 -r 5d26872c0260 docs/index.rst --- a/docs/index.rst Mon Jun 14 20:55:51 2010 -0400 +++ b/docs/index.rst Mon Jun 14 21:09:16 2010 -0400 @@ -9,7 +9,40 @@ hg-review is a `Mercurial `_ extension for performing distributed code review. -Contents: +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:: + + cd hg-review + hg review --init + +Start the web interface:: + + 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 +------------ .. toctree:: :maxdepth: 2 @@ -18,9 +51,15 @@ concepts webui cli + +Developer's Guide +----------------- + +.. toctree:: + :maxdepth: 2 + api - Indices and tables ------------------