Improve docs (#20)

* Add a brief framework description * Add a brief demo description
imcatta · Feb 4, 2019 · b169bc7 · b169bc7
1 parent 503aa79
commit b169bc7
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 1 deletion.
diff --git a/docs/demo.rst b/docs/demo.rst
@@ -1,5 +1,16 @@
-Run the demo
+Demo
 ============
+
+The demo aims to emulate a sequence of light poles
+along a path. To save energy, the light poles are turned on
+in an alternate fashion (in this specific case one on and one off, but it is possible to change criterion).
+If, for some reasons, a light bulbs went out the system will be able to self-heal himself
+by adjusting the list of lights on to reduce
+at least the discomfort due to the breakage of the bulb.
+
+Run the demo
+------------
+
 1. Activate your workspace.
 
 .. code-block:: bash

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,6 +1,11 @@
 Welcome to ROS MAPE-K Framework's documentation!
 ================================================
 
+*ROS MAPE-K Framework* is a simple framework that help developers build `ROS`_ 
+applications based on the MAPE-K pattern. 
+
+.. _`ROS`: http://ros.org
+
 .. _getting-started:
 
 .. toctree::