Skip to content

Commit

Permalink
added some changes to documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Stefano Bernagozzi <[email protected]>
  • Loading branch information
ste93 committed May 22, 2024
1 parent 511175c commit da0aa24
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 ..
Expand Down
4 changes: 2 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -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,
Expand Down Expand Up @@ -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
----------
Expand Down

0 comments on commit da0aa24

Please sign in to comment.