Skip to content

Commit

Permalink
Minor updates to documentation and docker compose file for new instru…
Browse files Browse the repository at this point in the history
…ctions

Related to space-ros/space-ros#178
  • Loading branch information
franklinselva committed Sep 11, 2024
1 parent e68ca4d commit a71dbb1
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 37 deletions.
22 changes: 4 additions & 18 deletions canadarm2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,7 @@ This is a simple demo of controlling the canadarm using spaceROS.

To start the demo, there are few dependencies that need to be installed. The following steps will guide you through the installation process.

1. You will need ROS Humble on your host system. If it is not already installed, you can follow the instructions [here](https://docs.ros.org/en/humble/Installation.html).
2. You will need Gazebo Sim installed on your system. If not, you can follow the instructions [here](https://gazebosim.org/docs/all/getstarted/).
3. You will need docker installed on your system. If not, you can follow the instructions [here](https://docs.docker.com/get-docker/).
4. Install xterm for running the demo. You can install it using the following command.
```bash
sudo apt-get install xterm
```
1. You will need docker installed on your system. If not, you can follow the instructions [here](https://docs.docker.com/get-docker/).

### How to run the demo

Expand All @@ -24,22 +18,14 @@ To start the demo, there are few dependencies that need to be installed. The fol
```bash
cd canadarm2
```
3. To build the demo, we use `./build.sh`. You can do the following to build the demo.
```bash
# To see the list of available commands
./build.sh help
```
4. To build the demo, you can use the following command.
3. To build the demo, you can use the following command.
```bash
# To build the demos for the canadarm2
./build.sh
# Cleanup the build
./build.sh clean
```
5. To run the demo, you can use the following command.
4. To run the demo, you can use the following command.
```bash
# To run the demo
# To run the demos for the canadarm2
./run.sh
```

Expand Down
2 changes: 1 addition & 1 deletion canadarm2/docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ version: "3"

services:
canadarm_gui:
image: osrf/space-ros:gui
image: osrf/space-ros:canadarm_gui
build:
context: ./
dockerfile: ./Dockerfile.GUI
Expand Down
20 changes: 3 additions & 17 deletions curiosity_rover/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,7 @@ This is a simple demo of controlling the curiosity rover using spaceROS.

To start the demo, there are few dependencies that need to be installed. The following steps will guide you through the installation process.

1. You will need ROS Humble on your host system. If it is not already installed, you can follow the instructions [here](https://docs.ros.org/en/humble/Installation.html).
2. You will need Gazebo Sim installed on your system. If not, you can follow the instructions [here](https://gazebosim.org/docs/all/getstarted/).
3. You will need docker installed on your system. If not, you can follow the instructions [here](https://docs.docker.com/get-docker/).
4. Install xterm for running the demo. You can install it using the following command.
```bash
sudo apt-get install xterm
```
1. You will need docker installed on your system. If not, you can follow the instructions [here](https://docs.docker.com/get-docker/).

### How to run the demo

Expand All @@ -24,20 +18,12 @@ To start the demo, there are few dependencies that need to be installed. The fol
```bash
cd curiosity_rover
```
3. To build the demo, we use `./build.sh`. You can run the following to build the demo
```bash
# To see the list of available commands
./build.sh help
```
4. To build the demo, you can use the following command.
3. To build the demo, you can use the following command.
```bash
# To build all the demos for the canadarm2
./build.sh
# To clean up the build,
./build.sh clean
```
5. To run the demo, you can use the following command.
4. To run the demo, you can use the following command.
```bash
# To run the demo
./run.sh
Expand Down
2 changes: 1 addition & 1 deletion curiosity_rover/docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ services:
count: 1
capabilities: [gpu]
curiosity_demo:
image: osrf/space-ros:canadarm_demo
image: osrf/space-ros:curiosity_demo
build:
context: ./
dockerfile: ./Dockerfile
Expand Down

0 comments on commit a71dbb1

Please sign in to comment.