aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMathieu Lirzin <mthl@gnu.org>2016-12-09 00:02:22 +0100
committerMathieu Lirzin <mthl@gnu.org>2016-12-09 00:15:26 +0100
commit5dc1bf40e96ee40f9e786ffeafc3eb895b4e8e74 (patch)
tree56f6eb3e4df72a4e26cf5aa211c9c9227c0b87f8
parente1b396b3c5ae674e5b444b9fd85f129db7a4f571 (diff)
downloadcuirass-5dc1bf40e96ee40f9e786ffeafc3eb895b4e8e74.tar
cuirass-5dc1bf40e96ee40f9e786ffeafc3eb895b4e8e74.tar.gz
doc: Write Introduction.
* doc/cuirass.texi (Introduction): Write it.
-rw-r--r--doc/cuirass.texi23
1 files changed, 22 insertions, 1 deletions
diff --git a/doc/cuirass.texi b/doc/cuirass.texi
index 4af5b5a..534cc03 100644
--- a/doc/cuirass.texi
+++ b/doc/cuirass.texi
@@ -59,7 +59,28 @@ Documentation License''.
@c *********************************************************************
@node Introduction
-@chapter Introduction
+@unnumbered Introduction
+@cindex introduction
+
+@dfn{Cuirass} is a general-purpose build automation server that checks
+out source files from @acronym{VCS, Version Control System}
+repositories, executes a @dfn{build job}, and notifies the results of
+that job. A build job consists of a combinaison of tasks such as
+compiling source code to binary code and running automated tests.
+Notification is achieved by using a database that stores the build
+results associated with an HTTP server that provides a convenient way to
+access them.
+
+Cuirass is inspired by the @url{https://nixos.org/hydra/, Hydra}
+continuous build system. Unlike Hydra, it is built on top of the
+@url{https://www.gnu.org/software/guix/, GNU Guix} functional package
+manager.
+
+The goal of Cuirass is to provide both on-demand, scheduled, and
+triggered builds. A Build server is an important tool in the software
+development process, because it allows modifying the source code while
+ensuring the portability and robustness of those changes. It is the
+basis of the @dfn{Continuous integration} practice.
@c *********************************************************************
@node Continuous Integration