some documentation on commands

[mw] / README

diff --git a/README b/README
index d1f1582cdd46ee0686f3d244b23a4e2ed6ed4d5f..a7224e53aa2e2c8f86f49b4a0247c9b718b5d8c5 100644 (file)
--- a/README
+++ b/README
@@ -1,15 +1,31 @@
 mw - VCS-like nonsense for MediaWiki websites
 mw - VCS-like nonsense for MediaWiki websites

-Copyright (C) 2009  Ian Weller <ian@ianweller.org>
+Copyright (C) 2011  Ian Weller <ian@ianweller.org> and others

 
 == 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=$PYTHONPATH:PATH_TO/mw/src PATH_TO/mw/bin/mw"
+where PATH_TO is the path to your local mw repository.

 
 

-mw init http://path.to/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 commit
 mw commit

+mw status
+
+== Status command ==
+
+Will show whether a file has been locally modified ('M') or is clean ('C').
+
+== Pull command ==
+
+The pull command has the following features:
+
+* Can pull a new page/file, or update one.
+* Can be provided a page name or file name.
+* If the wiki has updates, it will pull those unless they conflict 
+  with local changes. The user must then resolve/merge conflicts.
+

 
 == License ==
 This program is free software; you can redistribute it and/or modify
 
 == License ==
 This program is free software; you can redistribute it and/or modify