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         merge          run merge tool on conflicting locate/remove diffs
  29         pull           add remote pages to repo
  30         pullcat        add remote pages to repo belonging to the given category
  31         status (st)    check repo status
  32
  33 === Status command ===
  34
  35 `status` Will show whether a file has been locally modified ('M') or is clean ('C').
  36
  37 === Pull command ===
  38
  39 The `pull` command has the following features:
  40
  41 * Can pull a new page/file, or update one.
  42 * Can be provided a page name or file name.
  43 * If the wiki has updates, it will pull those unless they conflict
  44   with local changes. The user must then resolve/merge conflicts.
  45
  46 == License ==
  47
  48 This program is free software; you can redistribute it and/or modify
  49 it under the terms of the GNU General Public License as published by
  50 the Free Software Foundation; either version 2 of the License, or
  51 (at your option) any later version.
  52
  53 This program is distributed in the hope that it will be useful,
  54 but WITHOUT ANY WARRANTY; without even the implied warranty of
  55 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  56 GNU General Public License for more details.
  57
  58 You should have received a copy of the GNU General Public License along
  59 with this program.  If not, see <http://www.gnu.org/licenses/>.