From da0aa249e5215b243d40a47b59afec02e222d782 Mon Sep 17 00:00:00 2001 From: Stefano Bernagozzi Date: Wed, 22 May 2024 16:31:13 +0200 Subject: [PATCH] added some changes to documentation Signed-off-by: Stefano Bernagozzi --- README.md | 2 +- docs/source/index.rst | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1f199fa..a94c805 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ To install see [TinyXML2 Installation](https://github.com/leethomason/tinyxml2/t To compile the code run the following commands '''bash git clone https://github.com/convince-project/model2code.git -cd model2code +cd model2code/code mkdir build cd build cmake .. diff --git a/docs/source/index.rst b/docs/source/index.rst index 6658f21..67c430b 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,7 +1,6 @@ CONVINCE model2code Documentation ================================== -This is the documentation for the CONVINCE model2code tool. The tool is developed as part of the CONVINCE project. -The tool is used mainly to generate skill level code starting from an SCXML model. +The tool is developed as part of the CONVINCE project and is used mainly to generate skill level code starting from an SCXML model. The inputs of the program are: - an SCXML model that describes the behavior of the skill, - an XML file that describes the full model of the program, which includes the behavior tree, the skills and the components used in the system, @@ -29,6 +28,7 @@ The parameters required to run the program are: by default the program will generate the code in the directory where the SCXML file passed by the parameter ``--input_filename`` is located, but you can specify a different directory by using the parameter ``--output_path``. +The skills generated are based on a behavior tree structure and will have a ROS2 tick service in case they are a condition a ROS2 tick and halt services in case they are an action. Contents ----------