Make some changes to README and HACKING

diff --git a/HACKING b/HACKING
index 93100834f33a70918bebc28d7ee63e12a2c46936..cdb6c6b973ac2ee9543c744905f1cf5414e9e710 100644 (file)
--- 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
 
 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 71dddb8376525b77cac4b23100bec456471e72e5..1887524e83db88a36625eba702d814791b547311 100644 (file)
--- a/README
+++ b/README
@@ -2,14 +2,16 @@ mw - VCS-like nonsense for MediaWiki websites
 Copyright (C) 2010  Ian Weller <ian@ianweller.org>
 
 == Basic workflow ==
 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 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 ==
 mw commit
 
 == License ==