doc: improve getting started, add missing dependency

Suggested-by: Marco Frigerio <marco.frigerio@kuleuven.be> Signed-off-by: Markus Klotzbuecher <mk@mkio.de>
kmarkus · Jun 10, 2020 · 86af75e · 86af75e
1 parent cbdd9aa
commit 86af75e
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/docs/user/getting_started.rst b/docs/user/getting_started.rst
@@ -4,6 +4,12 @@ Getting started
 Microblx in a nutshell
 ----------------------
 
+Microblx is a lightweight framework to build function block based
+systems.  It is designed around a canonical component model with
+*ports* for data exchange, *configs* for configuration and a *state
+machine* for the "block" life cycle. Trigger blocks orchestrate the
+execution of the components functionality.
+
 Building a microblx application typically involves two steps:
 
 Implement the required blocks

diff --git a/docs/user/installing.rst b/docs/user/installing.rst
@@ -14,6 +14,7 @@ Make sure to install the following dependencies
 - ``cproto`` (apt: ``cproto``) use by Make to generate prototype
   header file
 - luajit (>=v2.0.0) (apt: ``luajit`` and ``libluajit-5.1-dev``)
+- lfs: lua-filesystem (apt: ``lua-filesystem``)
 
 The following must be installed from source (see instructions below):