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 == Setup ==
   5
   6 We don't have a nice installation process yet, so set the following alias:
   7   alias mw="PYTHONPATH=$PYTHONPATH:PATH_TO/mw/src PATH_TO/mw/bin/mw"
   8 where PATH_TO is the path to your local mw repository.
   9
  10 == Basic workflow ==
  11
  12 mw init http://example.com/w/api.php
  13 mw login  # if you need/want to
  14 mw pull 'Main Page'
  15 $EDITOR Main_Page.wiki
  16 mw commit
  17 mw status
  18
  19 == Commands ==
  20
  21 usage: mw [subcommand]
  22
  23         commit (ci)    commit changes to wiki
  24         diff           diff wiki to working directory
  25         init           start a mw repo
  26         login          authenticate with wiki
  27         logout         forget authentication
  28         pull           add remote pages to repo
  29         pullcat        add remote pages to repo belonging to the given category
  30         status (st)    check repo status
  31
  32 === Status command ===
  33
  34 `status` Will show whether a file has been locally modified ('M') or is clean ('C').
  35
  36 === Pull command ===
  37
  38 The `pull` command has the following features:
  39
  40 * Can pull a new page/file, or update one.
  41 * Can be provided a page name or file name.
  42 * If the wiki has updates, it will pull those unless they conflict
  43   with local changes. The user must then resolve/merge conflicts.
  44
  45 == License ==
  46
  47 This program is free software; you can redistribute it and/or modify
  48 it under the terms of the GNU General Public License as published by
  49 the Free Software Foundation; either version 2 of the License, or
  50 (at your option) any later version.
  51
  52 This program is distributed in the hope that it will be useful,
  53 but WITHOUT ANY WARRANTY; without even the implied warranty of
  54 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  55 GNU General Public License for more details.
  56
  57 You should have received a copy of the GNU General Public License along
  58 with this program.  If not, see <http://www.gnu.org/licenses/>.