add instructions to build the software from source

README.rst

@@ -4,7 +4,7 @@ autoradio
 =========
 
 The AutoRadio service aims to provide a reliable, fault-tolerant Icecast
-streaming network for audio and video. It provides all the necessary
+streaming cluster for audio and video. It provides all the necessary
 components to ensure that the traffic from the source to the clients
 is uninterrupted, even in face of high load or server crashes. All
 this, if possible, without any operator intervention.
@@ -80,7 +80,6 @@ bootstrap a new streaming cluster:
    ``DOMAIN=radio.example.com`` in ``/etc/default/autoradio``.
 
 
-
 Securing etcd
 +++++++++++++
 
@@ -99,6 +98,21 @@ certificate in ``/etc/autoradio/etcd_client.pem`` and its private key in
 *etcd* using SSL authentication.
 
 
+Building from source
+++++++++++++++++++++
+
+To build autoradio from source, you should have a Go environment set
+up properly on your machine. Autoradio uses godep_ to manage its
+dependencies, so make sure you have that installed as well. Building
+autoradio should then be as simple as running, from the top-level
+source directory::
+
+    $ godep go install ./...
+
+This should install the ``radiod``, ``redirectord`` and ``radioctl``
+executables in ``$GOPATH/bin``.
+
+
 Operation
 ---------
 
@@ -150,17 +164,16 @@ X509-based authentication to etcd.
 Instrumentation
 +++++++++++++++
 
-The ``redirectord`` daemon exports statistics on served queries (along
-with data on its own memory usage), in JSON format at the
-``/debug/vars`` URL.
+The ``radiod`` and ``redirectord`` daemons can send runtime metrics to
+a *statsd* server (by default on localhost:8125).
 
 
 Testing
 -------
 
 There's a Vagrant_ configuration in the ``vagrant-test`` subdirectory
-that will turn up a test three-node cluster (with Debian) using
-pre-packaged binaries. To run it::
+that will turn up a test three-node cluster (with Debian Wheezy as the
+base system) using pre-packaged binaries. To run it::
 
     $ cd vagrant-test
     $ vagrant up
@@ -173,4 +186,4 @@ Use ``vagrant ssh`` to inspect them.
 .. _etcd: https://github.com/coreos/etcd
 .. _autoca: https://git.autistici.org/ai/autoca
 .. _Vagrant: http://www.vagrantup.com/
-
+.. _godep: https://github.com/tools/godep