X-Git-Url: https://projects.mako.cc/source/mw/blobdiff_plain/856c67a6f2c8a618e94bf0c72af70e7d65bd10c4..e4ca6107fdb72b690cef9e6bacf438c5278d00b7:/README?ds=sidebyside diff --git a/README b/README index df2a37e..2cb0e82 100644 --- a/README +++ b/README @@ -1,9 +1,49 @@ mw - VCS-like nonsense for MediaWiki websites -Copyright (C) 2009 Ian Weller +Copyright (C) 2011 Ian Weller and others -For now, see HACKING for how to run this. This is far from complete and -we're hoping to have awesome features soon. If you would like to help -out, patches are greatly welcomed. +== 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 == + +mw init http://example.com/w/api.php +mw login # if you need/want to +mw pull 'Main Page' +$EDITOR Main_Page.wiki +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