60a287538a94

Add a sparse README.
[view raw] [browse files]
author Steve Losh <steve@stevelosh.com>
date Sun, 04 Oct 2009 22:25:33 -0400
parents 6d90ef243069
children 7e437c5261bb
branches/tags (none)
files README

Changes

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Sun Oct 04 22:25:33 2009 -0400
@@ -0,0 +1,39 @@
+-*- markdown -*-
+
+This is a work in progress.  I wouldn't try it out on anything important...
+
+Installing
+==========
+
+Get it:
+
+    hg clone http://bitbucket.org/sjl/hg-review/
+
+Add it to `~/.hgrc`:
+
+    [extensions]
+    review = [path to]/hg-review/review/
+
+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