projects
/
mw
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
tree
raw
|
patch
|
inline
| side by side (parent:
6fa5392
)
better explainations of commands
author
reagle
<joseph.2008@reagle.org>
Sat, 5 Feb 2011 01:52:34 +0000
(20:52 -0500)
committer
reagle
<joseph.2008@reagle.org>
Sat, 5 Feb 2011 01:52:34 +0000
(20:52 -0500)
README
patch
|
blob
|
history
diff --git
a/README
b/README
index a7224e53aa2e2c8f86f49b4a0247c9b718b5d8c5..f0b174e0a8a0559f253b448fcfe7e169cc72b1e7 100644
(file)
--- a/
README
+++ b/
README
@@
-1,11
+1,14
@@
mw - VCS-like nonsense for MediaWiki websites
Copyright (C) 2011 Ian Weller <ian@ianweller.org> and others
mw - VCS-like nonsense for MediaWiki websites
Copyright (C) 2011 Ian Weller <ian@ianweller.org> and others
-== Basic workflow ==
+== 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.
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'
mw init http://example.com/w/api.php
mw login # if you need/want to
mw pull 'Main Page'
@@
-13,21
+16,34
@@
$EDITOR Main_Page.wiki
mw commit
mw status
mw commit
mw status
-== Status command ==
+== Commands ==
+
+usage: mw [subcommand]
-Will show whether a file has been locally modified ('M') or is clean ('C').
+ 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
-==
Pull command
==
+==
= Status command =
==
-The pull command has the following features:
+`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.
* 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 ==
== 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
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
Benjamin Mako Hill
||
Want to submit a patch?