Update the README with instructions for trying it out.
author |
Steve Losh <steve@stevelosh.com> |
date |
Wed, 21 Oct 2009 19:31:15 -0400 |
parents |
635a1f3319c5
|
children |
5c274209a7ec
26150fdd04b8
|
branches/tags |
(none) |
files |
README |
Changes
--- a/README Wed Oct 21 19:17:44 2009 -0400
+++ b/README Wed Oct 21 19:31:15 2009 -0400
@@ -5,6 +5,8 @@
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/
@@ -14,6 +16,21 @@
[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 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
==========