X-Git-Url: https://projects.mako.cc/source/mw/blobdiff_plain/3f5f53235c5839a05e5db865579764c1d37fa3ea..9ef27bc8f58e620ef72264de998a0035321155f0:/README diff --git a/README b/README index 71dddb8..6c50091 100644 --- a/README +++ b/README @@ -1,15 +1,17 @@ mw - VCS-like nonsense for MediaWiki websites -Copyright (C) 2010 Ian Weller +Copyright (C) 2011 Ian Weller and others == 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://example.com/w/api.php -mw login # if you need/want to +mw login # if you need/want to 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 ==