document

1 files changed, 29 insertions, 1 deletions

diff --git a/README.md b/README.md
index 0def23d..5173340 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,22 @@
+Summary
+=======
+
+This repository contains various scripts and configuration files
+that manage the various deployments of GNU Taler at https://taler.net/.
+
+We use buildbot as the main driver of the deployment.  The various
+buildslaves are launched as user services by systemd.
+
+Buildbot jobs are used to:
+- generate the various (static) Web sites (www, coverage analysis, etc.)
+- launch the various interactive Taler services
+  (primarily demo.taler.net, test.taler.net, int.taler.net)
+- run unit tests
+
+A namespace/process jail is used to ensure there are no port conflicts or
+surviving processes for unit tests that require ports that might conflict.
+
+
 Deployment Layout
 =================
 
@@ -15,10 +34,19 @@ systemd-services/ -- service definitions for buildbot build-slaves
 taler-arm/ -- gnunet-arm configurations for a deployment
 taler-sitesbuild/ -- scripts for updating our Web sites
 
-TODO:
+
+TODOS:
+======
+
+1) Inconsistency:
 
 bootstrap-* -- shell scripts to setup the accounts to run some of the services on taler.net; TODO: should likely be integrated with "$ bin/taler-deployment bootstrap" logic for uniformity
 
+2) envcfg.py files MUST currently exist in (most) $HOME directories of buildbot jobs.
+   However, they are not yet versioned here. We should version them, and deploy the
+   envconfigs also via the respective buildbot jobs.
+
+3) Undocumented:
 
 mypy/ -- MARCELLO?
 prepare-* -- MARCELLO?