8239d5054898

guts: update README
[view raw] [browse files]
author Steve Losh <steve@stevelosh.com>
date Tue, 13 Jul 2010 01:57:12 -0400
parents 613600cac7dd
children a00c883bebfc
branches/tags (none)
files README.markdown

Changes

--- a/README.markdown	Tue Jul 13 01:35:26 2010 -0400
+++ b/README.markdown	Tue Jul 13 01:57:12 2010 -0400
@@ -1,17 +1,9 @@
-hg-review is not currently stable!
-==================================
-
-Do not use it for anything mission-critical!
-============================================
+hg-review is close to beaing released!
+======================================
 
-Seriously, it might break at any moment!
-========================================
-
+Feedback is appreciated, but things may still break before v1.0.0!
+==================================================================
 
-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
 ==========
@@ -34,11 +26,8 @@
 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:
+`hg-review` uses itself for code review. If you want to get a quick taste of
+how it works:
 
     cd path/to/wherever/you/cloned/hg-review
     hg review --init
@@ -47,26 +36,14 @@
 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:
+There's also a [live, read-only demo][demo] if installing is too much
+committment for you.
 
-    pip install nose
-
-Don't have pip?  Get it.  But if you *really* want to `easy_install`...
-
-    easy_install nose
+[demo]: http://review.stevelosh.com/
 
-Run the unit tests:
-
-    cd [path to]/hg-review
-    nosetests
+Documentation
+=============
 
-Progress
-========
+Check out the [documentation][docs] to learn more.
 
-Take a look at the list of tests to see what I've got working so far:
-
-    cd [path to]/hg-review
-    nosetests -v
+[docs]: http://sjl.bitbucket.org/hg-review/