From a1e83cfc6ddff0ef568c3bb9813b572fd7e16d13 Mon Sep 17 00:00:00 2001 From: Matthew Hansen Date: Wed, 4 Sep 2024 08:26:00 -0700 Subject: [PATCH] Add build instructions to README (fix issue #35) --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9f178b65..47e3bd4b 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,12 @@ This repository provides examples for running robots using Space ROS -Please refer to the [dockerfile repo](https://github.com/space-ros/docker/tree/main/space_robots) for running instruction +Submissions to this repo should include: +1) A Dockerfile or docker-compose.yaml file for building on top of the `osrf/space-ros:latest` +2) A `build.sh` script for building the docker image + - This is required for CI to build the image + - See example here: https://github.com/space-ros/docker/blob/main/space_robots/build.sh +3) A `run.sh` script for running the demo + - - See example here: https://github.com/space-ros/docker/blob/main/space_robots/run.sh + +Please refer to the [dockerfile repo](https://github.com/space-ros/docker/tree/main/space_robots) for instructions on running the existing demos