Skip to content

Commit

Permalink
ogma-cli: Document new Dockerfile. Refs #136.
Browse files Browse the repository at this point in the history
A prior commit has modified the `ros` command to generate an additional
Dockerfile. This commit adjusts the documentation in the README to let
users know what the Dockerfile is for and how to build the image.
  • Loading branch information
ivanperez-keera committed May 21, 2024
1 parent c3c5063 commit d6ccecc
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions ogma-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,16 @@ ros_demo/copilot/src/copilot_monitor.cpp
ros_demo/copilot/src/copilot_logger.cpp
ros_demo/copilot/src/.keep
ros_demo/copilot/package.xml
ros_demo/Dockerfile
```

The Dockerfile can be used to compile the application inside the base image for
the Space ROS distribution. To build the image, first place the core
implementation of the monitors in C inside the directory
`ros_demo/copilot/src/` (see 'Current limitations' for details). After, you can
compile the image with:
```
docker build .
```

### Current limitations
Expand Down

0 comments on commit d6ccecc

Please sign in to comment.