Build instructions for Aquarium

diff --git a/doc/manual/source/adminguide.rst b/doc/manual/source/adminguide.rst
index 6c6a2e0..c583bae 100644 (file)
--- a/doc/manual/source/adminguide.rst
+++ b/doc/manual/source/adminguide.rst
@@ -7,13 +7,20 @@ Introduction
 The administration guide includes details on how an Aquarium setup should
 look like.
 
+Installation and Configuration
+------------------------------
+
+Aquarium is distributed as a TAR archive or through its source code repository
+from `project home location <https://code.grnet.gr/aquarium>`. 
+
+
 Document Revisions
 ^^^^^^^^^^^^^^^^^^
 
 ==================    ================================
 Revision              Description
 ==================    ================================
-foo                   bar
+0.1 (Mar 2012)        Initial version 
 ==================    ================================
 
 

diff --git a/doc/manual/source/devguide.rst b/doc/manual/source/devguide.rst
index 7885718..58ed259 100644 (file)
--- a/doc/manual/source/devguide.rst
+++ b/doc/manual/source/devguide.rst
@@ -4,6 +4,42 @@ Aquarium Development Guide
 The development guide includes descriptions of the APIs and extention points
 offered by Aquarium. It also includes design and development setup information.
 
+Obtaining and Compiling
+-----------------------
+
+The source code to the Aquarium project can be obtained through Git, by
+cloning the repository `http://code.grnet.gr/git/aquarium`. This will give
+you read-only access to the repository. You need to contact the Aquarium
+team to obtain read-write access.
+
+To compile Aquarium, you need the following software in your path:
+
+- Java SDK 6. Java 7 has not been tested yet.
+- `Maven <http://maven.apache.org>`_, version > 3
+
+After you install them, you can do the following:
+
+- ``mvn install``: To compile Aquarium and run the tests. This will also create 
+  the file ``target/aquarium-<ver>-jar-with-dependencies.jar`` which can be
+  used to start Aquarium from the command line
+- ``mvn deploy``:  To deploy the Aquarium libraries to the remote Maven repository
+- ``mvn release:prepare``, ``mvn release:perform``: To prepare a release,
+  tag a new version and start the next development version
+- ``mvn scala:cctest``: To run the Scala compiler in continuous compilation
+  mode
+
+Aquarium can also be build with the Simple Build Tool
+(`SBT <https://github.com/harrah/xsbt/wiki>`_). Just run ``sbt`` in the directory 
+containing the Aquarium source code.
+
+Distributing
+^^^^^^^^^^^^
+
+To prepare a binary distribution of Aquarium, use the ``make-dist.sh`` script.
+If the script is run without an argument, it will create a TAR archive from
+the latest tagged version of Aquarium. The script also accepts a Git commit-ish,
+in which case it will build a TAR archive out of the provided Git commit.
+
 Overall architecture
 --------------------