Skip to content

Commit

Permalink
Place sentences in separate lines in READMEs (#113).
Browse files Browse the repository at this point in the history
Having long sentences in READMEs makes them harder to change, and also makes
processing the diffs harder (among other disadvantages).

This commit implements the one-sentence-per-line principle, by placing
different sentences in separate lines in the README.
  • Loading branch information
sea-bass authored and ivanperez-keera committed Jan 12, 2024
1 parent d22cea3 commit 211d91e
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 7 deletions.
6 changes: 4 additions & 2 deletions moveit2/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# MoveIt2 Docker Image

The MoveIt2 Docker image uses the Space ROS docker image (*openrobotics/spaceros:latest*) as its base image. The MoveIt2 Dockerfile installs all of the prerequisite system dependencies to build MoveIt2 (and Moveit2 tutorials) and then pulls and builds the latest MoveIt2 and Moveit2 tutorials source code.
The MoveIt2 Docker image uses the Space ROS docker image (*openrobotics/spaceros:latest*) as its base image.
The MoveIt2 Dockerfile installs all of the prerequisite system dependencies to build MoveIt2 (and Moveit2 tutorials) and then pulls and builds the latest MoveIt2 and Moveit2 tutorials source code.

## Building the MoveIt2 Image

Expand Down Expand Up @@ -37,7 +38,8 @@ There is a run.sh script provided for convenience that will run the spaceros ima
./run.sh
```

Upon startup, the container automatically runs the entrypoint.sh script, which sources the MoveIt2 and Space ROS environment files. You'll now be running inside the container and should see a prompt similar to this:
Upon startup, the container automatically runs the entrypoint.sh script, which sources the MoveIt2 and Space ROS environment files.
You'll now be running inside the container and should see a prompt similar to this:

```
spaceros-user@8e73b41a4e16:~/moveit2#
Expand Down
7 changes: 5 additions & 2 deletions space_robots/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
# Space ROS Space Robots Demo Docker Image

The Space ROS Space Robots Demo docker image uses the moveit2 docker image (*openrobotics/moveit2:latest*) as its base image. Build instructions for that image can be found at [docker/moveit2/README.md](https://github.com/space-ros/docker/blob/main/moveit2/README.md). The Dockerfile installs all of the prerequisite system dependencies along with the demos source code, then builds the Space ROS Space Robots Demo.
The Space ROS Space Robots Demo docker image uses the moveit2 docker image (*openrobotics/moveit2:latest*) as its base image.
Build instructions for that image can be found in [this README](../moveit2/README.md).
The Dockerfile installs all of the prerequisite system dependencies along with the demos source code, then builds the Space ROS Space Robots Demo.

This is for Curiosity Mars rover and Canadarm demos.

## Building the Demo Docker

The demo image builds on top of the `spaceros` and `moveit2` images. To build the docker image, first build both required images, then the `space_robots` demo image:
The demo image builds on top of the `spaceros` and `moveit2` images.
To build the docker image, first build both required images, then the `space_robots` demo image:

```bash
cd docker/spaceros
Expand Down
8 changes: 5 additions & 3 deletions spaceros/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The build process defaults to cloning the `ros2.repos` file from [spaceros](http
Example:
```bash
earthly +image --SPACEROS_REPO_URL="https://github.com/my-org/my-spaceros-fork.git" --SPACEROS_GIT_REF="my-branch-name"
```
```

## Running the Space ROS Docker Image in a Container

Expand Down Expand Up @@ -47,7 +47,8 @@ There is a run.sh script provided for convenience that will run the spaceros ima
./run.sh
```

Upon startup, the container automatically runs the entrypoint.sh script, which sources the Space ROS environment file (setup.bash). You'll now be running inside the container and should see a prompt similar to this:
Upon startup, the container automatically runs the entrypoint.sh script, which sources the Space ROS environment file (setup.bash).
You'll now be running inside the container and should see a prompt similar to this:

```
spaceros-user@d10d85c68f0e:~/spaceros$
Expand Down Expand Up @@ -221,7 +222,8 @@ To generate a JUnit XML file for a specific package only, you can add the *--pac
spaceros-user@d10d85c68f0e:~/spaceros$ colcon test --build-base build_ikos --install-base install_ikos --packages-select rcpputils
```

The `colcon test` command runs various tests, including IKOS report generation, which reads the IKOS database generated in the previous analysis step and generates a JUnit XML report file. After running `colcon test`, you can view the JUnit XML files. For example, to view the JUnit XML file for IKOS scan of the rcpputils binaries you can use the following command:
The `colcon test` command runs various tests, including IKOS report generation, which reads the IKOS database generated in the previous analysis step and generates a JUnit XML report file.
After running `colcon test`, you can view the JUnit XML files. For example, to view the JUnit XML file for IKOS scan of the rcpputils binaries you can use the following command:

```
spaceros-user@d10d85c68f0e:~/spaceros$ more build_ikos/rcpputils/test_results/rcpputils/ikos.xunit.xml
Expand Down

0 comments on commit 211d91e

Please sign in to comment.