summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2014-10-12 18:38:27 +0300
committerRichard Ipsum <richardipsum@fastmail.co.uk>2014-10-13 15:22:29 +0100
commit51daa9824b79690c96fd8ce65bc9ab2754f6a5c2 (patch)
treee4cf0db896c3f846e09db50e4eed4475acd2363b /README
parent40beef383b81686a02f3b73be7b1f9dfe04e7547 (diff)
downloadlorry-controller-51daa9824b79690c96fd8ce65bc9ab2754f6a5c2.tar.gz
Add an overview section to README
Diffstat (limited to 'README')
-rw-r--r--README25
1 files changed, 21 insertions, 4 deletions
diff --git a/README b/README
index e869a76..50faaaf 100644
--- a/README
+++ b/README
@@ -1,10 +1,27 @@
README for lorry-controller
===========================
-Lorry Controller mirrors Troves and mirrors or converts upstream
-projects into git repositories on the local Trove. Lorry Controller
-reads a configuration file (see below) and runs the Lorry program
-against the intended targets at suitable intervals.
+Overview
+--------
+
+Lorry Controller, or LC for short, manages the importing of source
+code from external sources into git repositories on a Trove. A Trove
+is a component in the Baserock system for hosting source code, and LC
+runs inside a Trove.
+
+LC uses the Lorry tool to do the actual import. Lorry can read code
+from several different version control systems, and convert them to
+git. External repositories can be specfied individually, as Lorry
+`.lorry` specification files. In addition, LC can be told to mirror
+all the git repositories on another Trove.
+
+LC runs Lorry for the right external repositories, and takes care of
+running a suitable number of Lorry instances concurrently, and
+recovering from any problems. LC has a web based administration
+interface, and an HTTP API for reporting and controlling its state.
+
+This README file documents the LC configuration file and general use.
+For the architecture of LC and the HTTP API, see the `ARCH` file.
Lorry Controller configuration
------------------------------