surveil/doc/source/getting_started.rst
aviau 5d356740b0 Added documentation for make build
Change-Id: I170f869e2a5b9be38067fe757d60dfa5a0ea7725
2014-12-15 00:44:18 -05:00

20 lines
587 B
ReStructuredText

.. role:: bash(code)
:language: bash
===============
Getting Started
===============
Developpement environnement
===========================
Surveil's developpement environnement is based on Docker and fig. There is a Makefile
at the root of the repository with commands to make it easier to use:
* :bash:`make up`: Launch Surveil and its dependencies in containers.
* :bash:`make down`: Kill the active docker containers, if any.
* :bash:`build`: Build the surveil container.
Configuration for the different services running in the Docker container are
stored in tools/docker.