projects.mako.cc - mw/blob - README

   1 mw - VCS-like nonsense for MediaWiki websites
   2 Copyright (C) 2011  Ian Weller <ian@ianweller.org> and others
   3
   4 == Basic workflow ==
   5 We don't have a nice installation process yet, so set the following alias:
   6   alias mw="PYTHONPATH=$PYTHONPATH:PATH_TO/mw/src PATH_TO/mw/bin/mw"
   7 where PATH_TO is the path to your local mw repository.
   8
   9 mw init http://example.com/w/api.php
  10 mw login  # if you need/want to
  11 mw pull 'Main Page'
  12 $EDITOR Main_Page.wiki
  13 mw commit
  14 mw status
  15
  16 == Status command ==
  17
  18 Will show whether a file has been locally modified ('M') or is clean ('C').
  19
  20 == Pull command ==
  21
  22 The pull command has the following features:
  23
  24 * Can pull a new page/file, or update one.
  25 * Can be provided a page name or file name.
  26 * If the wiki has updates, it will pull those unless they conflict
  27   with local changes. The user must then resolve/merge conflicts.
  28
  29
  30 == License ==
  31 This program is free software; you can redistribute it and/or modify
  32 it under the terms of the GNU General Public License as published by
  33 the Free Software Foundation; either version 2 of the License, or
  34 (at your option) any later version.
  35
  36 This program is distributed in the hope that it will be useful,
  37 but WITHOUT ANY WARRANTY; without even the implied warranty of
  38 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  39 GNU General Public License for more details.
  40
  41 You should have received a copy of the GNU General Public License along
  42 with this program.  If not, see <http://www.gnu.org/licenses/>.