Add README, add a bit to HACKING
authorIan Weller <ian@ianweller.org>
Mon, 7 Dec 2009 03:18:23 +0000 (22:18 -0500)
committerIan Weller <ian@ianweller.org>
Mon, 7 Dec 2009 03:18:23 +0000 (22:18 -0500)
HACKING
README [new file with mode: 0644]

diff --git a/HACKING b/HACKING
index 6ceec4a726fd2ec2f88804620f6707b1717ef025..93100834f33a70918bebc28d7ee63e12a2c46936 100644 (file)
--- a/HACKING
+++ b/HACKING
@@ -1,2 +1,6 @@
 Run this awesome whatnot with:
   PYTHONPATH=$PWD/src bin/mw
+
+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!
diff --git a/README b/README
new file mode 100644 (file)
index 0000000..c77b07a
--- /dev/null
+++ b/README
@@ -0,0 +1,20 @@
+mw - VCS-like nonsense for MediaWiki websites
+Copyright (C) 2009  Ian Weller <ian@ianweller.org>
+
+For now, see HACKING for how to run this. This is far from complete and
+we're hoping to have awesome features soon. If you would like to help
+out, patches are greatly welcomed.
+
+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
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program; if not, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

Benjamin Mako Hill || Want to submit a patch?