Update docs on component tests and mailing list

2 files changed, 37 insertions, 2 deletions

diff --git a/HACKING b/HACKING
new file mode 100644
index 0000000..ff8b450
--- /dev/null
+++ b/HACKING
@@ -0,0 +1,29 @@
+Running the Tests
+-----------------
+The tests are run via
+
+    python setup.py nosetests
+
+To also run the component tests you need to initialize the git submodules once
+via:
+
+    git submodule update --init --recursive
+
+This will fetch the necessary binary data for the DEB and RPM component tests
+and the tests are from now on included within each regular test run.
+
+
+Building the API Docs
+---------------------
+You can build the API docs using
+
+    epydoc -v --config=setup.cfg
+
+
+Contributing Patches
+--------------------
+Make sure the tests pass before sending in patch. You can either send it to the
+mailing list or add it to a bug report against git-buildpackage on
+
+    http://bugs.debian.org/src:git-buildpackage
+
diff --git a/README b/README
index 7a827fb..998efff 100644
--- a/README
+++ b/README
@@ -1,8 +1,7 @@
 Git-buildpackage
 ----------------
 This is a bunch of scripts to ease the development of Debian packages with git.
-For more documentation on howto use these tools see the manual
-online at:
+For more documentation on how to use these tools see the manual online at:
 
     http://honk.sigxcpu.org/projects/git-buildpackage/manual-html/gbp.html
 
@@ -12,3 +11,10 @@ On Debian systems this can be found in
 The API documentation of the gbp module can be found at:
 
     http://honk.sigxcpu.org/projects/git-buildpackage/apidocs/
+
+The mailing list is at:
+
+    http://lists.sigxcpu.org/mailman/listinfo/git-buildpackage
+    git-buildpackage at lists.sigxcpu.org
+
+See the HACKING document for details on contributing to gbp development.