From: Ian Weller Date: Mon, 24 May 2010 22:41:57 +0000 (-0500) Subject: Make some changes to README and HACKING X-Git-Url: https://projects.mako.cc/source/mw/commitdiff_plain/321c534c94a5b6c046e55ebff33f852a5a8e94e1 Make some changes to README and HACKING --- diff --git a/HACKING b/HACKING index 9310083..cdb6c6b 100644 --- a/HACKING +++ b/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. diff --git a/README b/README index 71dddb8..1887524 100644 --- a/README +++ b/README @@ -2,14 +2,16 @@ mw - VCS-like nonsense for MediaWiki websites Copyright (C) 2010 Ian Weller == 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 ==