changeset 186:c7172ca54dff

more docs
author Jeff Hammel <jhammel@mozilla.com>
date Tue, 01 Feb 2011 19:19:36 -0800
parents d8351b7b9edb
children bba97450cbc2
files README.txt
diffstat 1 files changed, 32 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/README.txt	Tue Feb 01 19:08:28 2011 -0800
+++ b/README.txt	Tue Feb 01 19:19:36 2011 -0800
@@ -35,9 +35,19 @@
 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. 
+subdirectories.  You can list the available factories with
+``create-autobot --list-factories`` (or ``create-autobot-master
+--list-factories``).
 
+Running ``create-autobot --help`` will give the variables you can set
+when it makes a new bot for you (``create-autobot-master`` and
+``create-autobot-slave`` also have a ``--help``, the variables in
+``create-autobot`` being a superset of these).
 
+If you don't specify a variable, the default will be used to create
+your particular bot.  You can (probably) change it later.
+
+ 
 Using autobot
 -------------
 
@@ -57,8 +67,29 @@
 * firebug        [TODO]
 * jetpack        [TODO]
 
+The projects are obtained from any factories in subdirectories of
+``autobot.projects`` (use 
+``python -c 'from autobot import projects; print projects.__file__'`` 
+to see this location).
+
 
 Adding a New Project
 --------------------
 
 Occassionally, you'll need to add a new project to test.
+
+
+Is your autobot being feisty?
+-----------------------------
+
+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!
+
+
+TODO
+----
+
+No software of any size is ever finished
+
+* singular checkout of repos on slaves
+* passing slave environment to master -> MozInfo