Skip to content
This repository has been archived by the owner on Jun 15, 2018. It is now read-only.

Commit

Permalink
Make some changes to README and HACKING
Browse files Browse the repository at this point in the history
  • Loading branch information
Ian Weller committed May 24, 2010
1 parent b30dcd7 commit 321c534
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 7 deletions.
20 changes: 16 additions & 4 deletions HACKING
@@ -1,6 +1,18 @@
Run this awesome whatnot with:
PYTHONPATH=$PWD/src bin/mw
_____________________________
< Patches are always welcome! >
-----------------------------
\ ,__,
\ (oo)____
(__) )\
||--|| *

The preferred method of submitting patches is by forking the repository,
committing changes, and then making the repository accessible. This is most
easily done on GitHub, but you can put it anywhere I can get it.

Changing how something already works in the .mw metadir requires a damn
good reason and we don't want to introduce incompatibilities at all in
the tree. On the other hand, patches are greatly welcomed!
good reason since we don't want to introduce incompatibilities at all in
the tree.

Code submitted should follow PEP 8. If it doesn't, I'll modify your changes (in
later commits) until they are in line that style.
8 changes: 5 additions & 3 deletions README
Expand Up @@ -2,14 +2,16 @@ mw - VCS-like nonsense for MediaWiki websites
Copyright (C) 2010 Ian Weller <ian@ianweller.org>

== Basic workflow ==
See HACKING on how to run this; a nice setup.py isn't done yet.
We don't have a nice installation process yet, so set the following alias:
alias mw="PYTHONPATH=PATH_TO/mw/src PATH_TO/mw/bin/mw"
where PATH_TO is the path to your local mw repository.

mw init http://example.com/w/api.php
mw login # if you need/want to
mw pull 'Main Page'
$EDITOR Main_Page.wiki
mw fetch # check for newer revisions
mw update # apply newer revisions
mw fetch # check for newer revisions; this command doesn't exist yet
mw update # apply newer revisions; this command doesn't exist yet
mw commit

== License ==
Expand Down

0 comments on commit 321c534

Please sign in to comment.