[pypy-svn] buildbot commit 3a7c89443fc8: write a readme

[commits-noreply at bitbucket.org]

# HG changeset patch -- Bitbucket.org
# Project buildbot
# URL http://bitbucket.org/pypy/buildbot/overview
# User Antonio Cuni <anto.cuni at gmail.com>
# Date 1288884345 -3600
# Node ID 3a7c89443fc8703d6aed49589c81a89985e5b8a7
# Parent  7b0fa3515f0dda4c5b2b0005672db4c49e1f4311
write a readme

--- /dev/null
+++ b/README
@@ -0,0 +1,30 @@
+.. -*- mode: rst -*-
+
+How to hack the PyPy buildbot
+==============================
+
+If you want to run buildbot locally, you need to:
+
+  1. create a file ``master/slaveinfo.py`` which contains the password for the
+     local slave you will run::
+
+         passwords = {"localhost": "an_arbitrary_password" }
+
+  2. ``cd master; make debug``
+
+  3. ``cd slave; make debug``
+
+
+How to run the PyPy buildbot
+============================
+
+If you want to run buildbot in production, you need to make sure that the
+function ``pypybuildbot.util.we_are_debugging`` returns ``False`` in your
+environment.  At the moment of writing, debugging is enabled everywhere but on
+codespeak.net.
+
+You still need to fill ``master/slaveinfo.py`` with the passwords of the
+various slaves you want to use.
+
+Then, to start the buildbot master: ``cd master; make start``
+