X-Git-Url: https://projects.mako.cc/source/mw/blobdiff_plain/e20392dd7415616f40ec65b4b5e2f9a2dc6efe4d..6fa53928d9818f92117b6d10bf2c080bec608a3f:/README diff --git a/README b/README index 1887524..a7224e5 100644 --- a/README +++ b/README @@ -1,18 +1,31 @@ mw - VCS-like nonsense for MediaWiki websites -Copyright (C) 2010 Ian Weller +Copyright (C) 2011 Ian Weller and others == Basic workflow == 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" + 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; this command doesn't exist yet -mw update # apply newer revisions; this command doesn't exist yet 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