Rewrite README.

1 files changed, 43 insertions, 18 deletions

diff --git a/README b/README
index 528ece1..075c3b2 100644
--- a/README
+++ b/README
@@ -1,23 +1,48 @@
-Scripts for the Linaro Android Build Service
+Scripts for the Linaro Cloud Buildd Service
 ============================================
 
-These scripts are used by the Linaro Android Build Service.
+About
+-----
+
+Linaro Cloud Buildd is a build service which distributes build load to the
+cloud (EC2). Linaro Cloud Buildd is based on Jenkins Continous Intregration
+server and constitutes of configuration, streamlined web frontend, setup
+and maintenance scripts, procedures and best practices all interfacing
+to Jenkins.
+
+This package hosts scripts which are used by the Linaro Cloud Buildd Service.
+Scripts are grouped by purpose by subdirectories:
 
-  node/
-    * Scripts that run on the Jenkins slaves.
-    root-setup-android-build-node
-      * Installs and configures a fresh EC2 node to be able to build
-        android.  Jenkins runs this when it provisions a new instance.
-    build-android
-      * Downloads and builds android.  Running this script is the meat
-        of the build step of the Jenkins job.
-    root-setup-android-toolchain-build-node, build-android-toolchain
-      * Not used at this time.
   control/
-    * Scripts that run on the Jenkins master
-    setup-control-node
-      * Mostly configures a blank node to be a jenkins master.
-    mangle-jobs
-      * A rather hairy script to allow batch editing of the Jenkins
-        jobs.
+    * Scripts to set up, control, and maintain Cloud Buildd.
+
+  node/
+    * Scripts to initialize and control build slaves.
+
+  build-scripts/
+    * Scripts which implement specific build types.
+
+
+Setting up Cloud Buildd
+-----------------------
+
+Cloud Buildd uses cloud instances to do the builds, and its control node is
+also intended to be installed in the cloud. It may be possible to install
+it on a standlone host, but set up scripts described below assume full control
+of the host, and may alter configuration of other software and services.
+
+    control/setup-control-node
+      * Sets up Cloud Buildd control node on a blank, freshly installed
+      host/instance. The host must run Ubuntu Server 10.10 and 11.04. Set up
+      procedure includes install and configuring Jenkins, Apache, and other
+      components and services used by Cloud Buildd.
+    control/setup-control-node-via-ssh
+      * Runs setup-control-node script above over SSH.
+    control/sandbox-create
+      * Creates EC2 instance and installs control node on it, all in one
+      step.
+
+Documentation
+-------------
 
+User Guide can be found at https://wiki.linaro.org/Platform/Android/LinaroAndroidBuildService