Skip to content

Commit 211d91e

Browse files
sea-bassivanperez-keera
authored andcommitted
Place sentences in separate lines in READMEs (#113).
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.
1 parent d22cea3 commit 211d91e

File tree

3 files changed

+14
-7
lines changed

3 files changed

+14
-7
lines changed

moveit2/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# MoveIt2 Docker Image
22

3-
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.
3+
The MoveIt2 Docker image uses the Space ROS docker image (*openrobotics/spaceros:latest*) as its base image.
4+
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.
45

56
## Building the MoveIt2 Image
67

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

40-
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:
41+
Upon startup, the container automatically runs the entrypoint.sh script, which sources the MoveIt2 and Space ROS environment files.
42+
You'll now be running inside the container and should see a prompt similar to this:
4143

4244
```
4345
spaceros-user@8e73b41a4e16:~/moveit2#

space_robots/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
# Space ROS Space Robots Demo Docker Image
22

3-
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.
3+
The Space ROS Space Robots Demo docker image uses the moveit2 docker image (*openrobotics/moveit2:latest*) as its base image.
4+
Build instructions for that image can be found in [this README](../moveit2/README.md).
5+
The Dockerfile installs all of the prerequisite system dependencies along with the demos source code, then builds the Space ROS Space Robots Demo.
46

57
This is for Curiosity Mars rover and Canadarm demos.
68

79
## Building the Demo Docker
810

9-
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:
11+
The demo image builds on top of the `spaceros` and `moveit2` images.
12+
To build the docker image, first build both required images, then the `space_robots` demo image:
1013

1114
```bash
1215
cd docker/spaceros

spaceros/README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ The build process defaults to cloning the `ros2.repos` file from [spaceros](http
1919
Example:
2020
```bash
2121
earthly +image --SPACEROS_REPO_URL="https://github.com/my-org/my-spaceros-fork.git" --SPACEROS_GIT_REF="my-branch-name"
22-
```
22+
```
2323

2424
## Running the Space ROS Docker Image in a Container
2525

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

50-
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:
50+
Upon startup, the container automatically runs the entrypoint.sh script, which sources the Space ROS environment file (setup.bash).
51+
You'll now be running inside the container and should see a prompt similar to this:
5152

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

224-
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:
225+
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.
226+
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:
225227

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

0 commit comments

Comments
 (0)