23930691ebe7

Update some README formatting.
[view raw] [browse files]
author Steve Losh <steve@stevelosh.com>
date Tue, 02 Mar 2010 18:39:42 -0500
parents 27419e0c5cfe
children 99b7409c4b45
branches/tags (none)
files README README.markdown

Changes

--- a/README	Sat Feb 06 11:53:33 2010 -0500
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,59 +0,0 @@
--*- markdown -*-
-
-This is a work in progress.  I wouldn't try it out on anything important...
-
-You can look at some [screenshots](http://www.flickr.com/photos/sjl7678/sets/72157622593551064/), but be warned that they might be a little out of date!
-
-Installing
-==========
-
-`hg-review` requires Mercurial (probably 1.3.1+).
-
-Get it:
-
-    hg clone http://bitbucket.org/sjl/hg-review/
-
-Add it to `~/.hgrc`:
-
-    [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 update webui
-    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
-==========
-
-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
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.markdown	Tue Mar 02 18:39:42 2010 -0500
@@ -0,0 +1,61 @@
+This is a work in progress.  I wouldn't try it out on anything important...
+
+You can look at some [screenshots][], but be warned that they might be a
+little out of date!
+
+[screenshots]: http://www.flickr.com/photos/sjl7678/sets/72157622593551064/
+
+Installing
+==========
+
+`hg-review` requires Mercurial (probably 1.3.1+).
+
+Get it:
+
+    hg clone http://bitbucket.org/sjl/hg-review/
+
+Add it to `~/.hgrc`:
+
+    [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 update webui
+    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
+==========
+
+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