diff --git a/README.md b/README.md index 522c3c7..0832faf 100644 --- a/README.md +++ b/README.md @@ -12,3 +12,42 @@ See individual template directories for details. * [rtems](./rtems) * [space_robots](./space_robots) * [zynq_rtems](./zynq_rtems) + + +### Build stacks + +To build the docker images available in the stack, run the following command: + +```bash +# To show the available options +./build.sh -help +# Usage: ./build.sh stack-name [options] +# USAGE +# -h, --help: display this help message +# stack-name: the name of the stack to build. Must be one of the following: +# - gui +# - nav2 +# - moveit2 + +# To build GUI stack +./build.sh gui +``` + +### Starting a stack container + +To run the docker images available in the stack, run the following command: + +```bash +# To show the available options +./run.sh -help +# Usage: ./build.sh stack-name [options] +# USAGE +# -h, --help: display this help message +# stack-name: the name of the stack to build. Must be one of the following: +# - gui +# - nav2 +# - moveit2 + +# To run GUI stack +./run.sh gui +```