mw - VCS-like nonsense for MediaWiki websites
-Copyright (C) 2009 Ian Weller <ian@ianweller.org>
+Copyright (C) 2011 Ian Weller <ian@ianweller.org> 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
+ 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
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 <http://www.gnu.org/licenses/>.
projects / mw / blobdiff