Skip to content

Commit

Permalink
Update README.md for building and running stacks
Browse files Browse the repository at this point in the history
Related to space-ros#188
y
  • Loading branch information
franklinselva committed Sep 26, 2024
1 parent 8c2dbf7 commit 726bf99
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

0 comments on commit 726bf99

Please sign in to comment.