x/surveil
Code Issues Proposed changes

Added documentation for developpment environnement

Browse Source 
Change-Id: I88d88745c21f8d0c6cd75dbb300b59ceff28b9a9
This commit is contained in:
aviau 2014-08-25 12:43:31 -04:00
parent d1a66be563
commit 79230990b3
2 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
doc/source/getting_started.rst Normal file
View File

@ -0,0 +1,19 @@
.. role:: bash(code)
:language: bash
===============
Getting Started
===============
Developpement environnement
===========================
Surveil's developpement environnement is based on Docker. There is a Makefile
at the root of the repository with commands to make it easier to use:
* :bash:`make run`: Launch Surveil inside a container in non-interactive mode.
* :bash:`make run-interactive`: Launch Surveil inside a container in interactive mode. You will have to start the services yourself.
* :bash:`make kill`: Kill the active docker containers, if any.
Configuration for the different services running in the Docker container are
stored in tools/docker.

1
doc/source/index.rst
View File

@ -8,6 +8,7 @@ Table of Contents:
:maxdepth: 2
readme
getting_started
webapi/index
Indices and tables