]> projects.mako.cc - mw/blobdiff - README
Make some changes to README and HACKING
[mw] / README
diff --git a/README b/README
index b3442665171618bf8bdd55f4d95dd1ffe06d5245..1887524e83db88a36625eba702d814791b547311 100644 (file)
--- a/README
+++ b/README
@@ -1,14 +1,17 @@
 mw - VCS-like nonsense for MediaWiki websites
 mw - VCS-like nonsense for MediaWiki websites
-Copyright (C) 2009  Ian Weller <ian@ianweller.org>
+Copyright (C) 2010  Ian Weller <ian@ianweller.org>
 
 == Basic workflow ==
 
 == Basic workflow ==
-See HACKING on how to run this; a nice setup.py isn't done yet.
+We don't have a nice installation process yet, so set the following alias:
+  alias mw="PYTHONPATH=PATH_TO/mw/src PATH_TO/mw/bin/mw"
+where PATH_TO is the path to your local mw repository.
 
 mw init http://example.com/w/api.php
 
 mw init http://example.com/w/api.php
+mw login # if you need/want to
 mw pull 'Main Page'
 $EDITOR Main_Page.wiki
 mw pull 'Main Page'
 $EDITOR Main_Page.wiki
-mw fetch # check for newer revisions
-mw update # apply newer revisions
+mw fetch # check for newer revisions; this command doesn't exist yet
+mw update # apply newer revisions; this command doesn't exist yet
 mw commit
 
 == License ==
 mw commit
 
 == License ==

Benjamin Mako Hill || Want to submit a patch?