diff --git a/source/Demos/Canadarm.rst b/source/Demos/Canadarm.rst index 93e1ff2..b85b564 100644 --- a/source/Demos/Canadarm.rst +++ b/source/Demos/Canadarm.rst @@ -1,7 +1,5 @@ Canadarm Demo ============= -TODO: +Instructions for running this demo can be found `here `_ . -Describe how to run the Canadarm demo. -This may be simply a link to the demo repo that provides the instructions. diff --git a/source/Demos/Mars-Rover.rst b/source/Demos/Mars-Rover.rst index bcdc603..0dd4ea0 100644 --- a/source/Demos/Mars-Rover.rst +++ b/source/Demos/Mars-Rover.rst @@ -1,7 +1,4 @@ Mars Rover Demo =============== -TODO: - -Describe how to run the Mars rover demo. -This may be simply a link to the demo repo that provides the instructions +Instructions for running this demo can be found `here `_ . diff --git a/source/Getting-Started/Docker-Images.rst b/source/Getting-Started/Docker-Images.rst index e1822e1..9f9c39a 100644 --- a/source/Getting-Started/Docker-Images.rst +++ b/source/Getting-Started/Docker-Images.rst @@ -1,9 +1,35 @@ The Space ROS Docker Images =========================== -TODO: +There are a few Space ROS Docker images you could use for your application, such as: + +* **space-ros:** This is the base SpaceROS image. +* **moveit2:** This image uses ``space-ros`` as base image and then pulls and builds the latest MoveIt2 source code. +* **space_robots:** This image uses ``space-ros`` as base image and then installs the demonstration source code necessary to run the Canadarm and Mars Rover demos. + +For a complete list of additional docker images, please refer to the `space-ros/docker repository `_ . + +space-ros image +--------------- + +The ``space-ros`` image can be accessed in two ways: + +* **Docker Hub** + + You can pull the space-ros image from `DockerHub `_ : + + .. code-block:: bash + + $ docker pull osrf/space-ros + +* **Build image locally** + + Follow the steps in the `USAGE.md `_ file from the ``space-ros`` repository. + + +space-robots image +------------------- + +If you want to test the robot demos, you'll need to build these images. Instructions for doing this are available in the space_robots `README `_ -Describe how to use the Space ROS docker image from Docker Hub, and any other images published to Docker Hub. -* Docker Hub -* Base image, MoveIt2, demos, etc. diff --git a/source/Introduction/How-Space-ROS-Differs.rst b/source/Introduction/How-Space-ROS-Differs.rst index 8f9d54a..7374551 100644 --- a/source/Introduction/How-Space-ROS-Differs.rst +++ b/source/Introduction/How-Space-ROS-Differs.rst @@ -111,6 +111,6 @@ The Space ROS project also incorporates space-specific functionality, such as a - `RTEMS `_ is an open source real-time operating system that supports open standard application programming interfaces such as POSIX and is used in space flight, medical, networking and many more embedded devices. To further support flight software systems we build Space ROS for RTEMS and have a demonstration application that runs on RTEMS. * - cFS/ROS 2 Bridge - - There is an active project, the `BRASH Integration Toolkit for ROS2 and Flight Software Interoperability `_, that promises to bridge the gap between Space ROS and legacy flight software systems. + - There is an active project, the `BRASH Integration Toolkit for ROS2 and Flight Software Interoperability `_, that promises to bridge the gap between Space ROS and legacy flight software systems. We hope to work with this project to integrate some of the core functionality into Space ROS.