surveil/doc/source/getting_started.rst
Frédéric Vachon fc99a34956 Make up now starts a development environment
Change-Id: I96549e4a6af70c9f90d3bf3d375f9ed59e636b1e
2015-04-03 15:34:55 -04:00

23 lines
742 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.
Surveil container mounts your local project folder and pecan reloads every
time the project files change thus providing a proper development environment.