X-Git-Url: https://projects.mako.cc/source/mw/blobdiff_plain/2580aa656abd825022506cb48ba5e34e50b61eb0..HEAD:/README diff --git a/README b/README index 0e7fc16..2cb0e82 100644 --- a/README +++ b/README @@ -1,18 +1,50 @@ mw - VCS-like nonsense for MediaWiki websites -Copyright (C) 2010 Ian Weller +Copyright (C) 2011 Ian Weller and others + +== Setup == + +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. == Basic workflow == -See HACKING on how to run this; a nice setup.py isn't done yet. -mw init http://example.com/w/api.php # use -u username if you like, - # you'll be asked for a password later +mw init http://example.com/w/api.php +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 commit +mw status + +== Commands == + +usage: mw [subcommand] + + commit (ci) commit changes to wiki + diff diff wiki to working directory + init start a mw repo + login authenticate with wiki + logout forget authentication + merge run merge tool on conflicting locate/remove diffs + pull add remote pages to repo + pullcat add remote pages to repo belonging to the given category + status (st) check repo status + +=== Status command === + +`status` 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 it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or