diff README.txt @ 187:bba97450cbc2

* update example and templates * more documentation
author Jeff Hammel <jhammel@mozilla.com>
date Tue, 01 Feb 2011 21:17:00 -0800
parents c7172ca54dff
children 5f188d2a36aa
line wrap: on
line diff
--- a/README.txt	Tue Feb 01 19:19:36 2011 -0800
+++ b/README.txt	Tue Feb 01 21:17:00 2011 -0800
@@ -51,6 +51,16 @@
 Using autobot
 -------------
 
+The buildmaster and buildslave are started with 
+``buildbot start master`` and ``buildslave stop slave``. Respective
+``stop`` commands also exist.  If you used the ``create-autobot``
+command the generated bot will have a ``restart_buildbot.py`` script
+that will stop and start both the master and slave and (if debug is
+set) remove the log as well.
+
+The generated ``master.cfg`` file reads values from an ``master.ini``
+file in the same directory
+
 It is important to remember that continuous integration is a safety
 net, not a first line of defense.  
 
@@ -76,7 +86,8 @@
 Adding a New Project
 --------------------
 
-Occassionally, you'll need to add a new project to test.
+Occassionally, you'll need to add a new project to test.  You can add
+a ``__init__.py`` file
 
 
 Is your autobot being feisty?
@@ -85,11 +96,17 @@
 Let me know! I'd like to make autobot a solution that works for all
 stake-holders, and if you're reading this, that means you!
 
+jhammel@mozilla.com
 
 TODO
 ----
 
-No software of any size is ever finished
+No software of any size is ever finished.  Here are a few things I
+would like to add:
 
-* singular checkout of repos on slaves
-* passing slave environment to master -> MozInfo
+* singular checkout of repos on slaves: the slaves should have a
+  singular master repo that is checked out once for each repo URL,
+  branch pair.  It is then updated as the slaves need and (e.g.)
+  cloned from there.  This should effectively minimize fetch time.
+
+* slaves should have .ini files indicated by the config