# HG changeset patch
# User Jeff Hammel <jhammel@mozilla.com>
# Date 1296615968 28800
# Node ID a5709ef5e275ffd6744befe9ae9ce352cc43616c
# Parent  225f88b6b1d65116d637dcf1cc0a9b74c3831314
additional documentation

diff -r 225f88b6b1d6 -r a5709ef5e275 README.txt
--- a/README.txt	Tue Feb 01 18:58:04 2011 -0800
+++ b/README.txt	Tue Feb 01 19:06:08 2011 -0800
@@ -3,23 +3,53 @@
 
 buildbot for the A*Team
 
-Using autobot
+
+What is autobot?
+----------------
 
-Autobot may be installed using the Install script::
+autobot is a continuous integration solution for the Automation and
+Tools Team.  We have a lot of software.  We're really talented, so
+usually it doesn't break.  But we're not infalliable.  Our robot ally,
+autobot, is there to test things for us.  Let's me autobot!
+
 
- curl http://...
+Installing autobot
+------------------
+
+autobot may be installed using the Install script::
+
+ curl http://k0s.org/mozilla/hg/autobot/raw-file/tip/INSTALL.sh | bash
 
 This will create a virtualenv and install autobot for development
-($VIRTUAL_ENV/src/autobot). You can create a master-slave pair by
-running ``create-autobot`` after activating the virtualenv. This is
-mostly useful for autobot development. The scripts ``create-autobot-master`` and
+($VIRTUAL_ENV/src/autobot). 
+
+
+Setting up a buildmaster and slave
+----------------------------------
+
+Once you have autobot installed and the virtualenv activated, you'll
+want to create a buildmaster and a buildslave.
+
+You can create a master-slave pair by running ``create-autobot`` after
+activating the virtualenv. This is mostly useful for autobot
+development. The scripts ``create-autobot-master`` and 
 ``create-autobot-slave`` are also available.  The scripts will prompt you
 for a factory. The factories are from ``autobot.projects`` and its
 subdirectories. 
 
+
+Using autobot
+-------------
+
+It is important to remember that continuous integration is a safety
+net, not a first line of defense.  
+
+
 Projects
 --------
 
+What does autobot test?
+
 * logparser      [WORKING]
 * profilemanager [IN FLIGHT]
 * mozmill        [IN FLIGHT]
@@ -27,3 +57,8 @@
 * firebug        [TODO]
 * jetpack        [TODO]
 
+
+Adding a New Project
+--------------------
+
+Occassionally, you'll need to add a new project to test.