X-Git-Url: https://projects.mako.cc/source/mw/blobdiff_plain/b21cc60a3bccf2ec4f477d07245df31b376ab316..6fa53928d9818f92117b6d10bf2c080bec608a3f:/README diff --git a/README b/README index c77b07a..a7224e5 100644 --- a/README +++ b/README @@ -1,10 +1,33 @@ 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. +== Basic workflow == +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 pull 'Main Page' +$EDITOR Main_Page.wiki +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 it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or @@ -16,5 +39,4 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along -with this program; if not, write to the Free Software Foundation, Inc., -51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. +with this program. If not, see .