diff --git a/doc/source/getting_started.rst b/doc/source/getting_started.rst new file mode 100644 index 0000000..b98b389 --- /dev/null +++ b/doc/source/getting_started.rst @@ -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. diff --git a/doc/source/index.rst b/doc/source/index.rst index 3b36b61..38dc1d4 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -8,6 +8,7 @@ Table of Contents: :maxdepth: 2 readme + getting_started webapi/index Indices and tables