Skip to content

Commit 7764129

Browse files
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 211d91e commit 7764129

File tree

3 files changed

+19
-9
lines changed

3 files changed

+19
-9
lines changed

renode_rcc/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# renode-RCC
2-
Building [RTEMS Cross Compilation System (RCC)](https://www.gaisler.com/index.php/products/operating-systems/rtems), has a different directory structure compare to building RTEMS from source (might not be true). This will run RTEMS on leon3 in a renode simulation.
2+
Building [RTEMS Cross Compilation System (RCC)](https://www.gaisler.com/index.php/products/operating-systems/rtems), has a different directory structure compare to building RTEMS from source (might not be true).
3+
This will run RTEMS on leon3 in a renode simulation.
34

45
## Usage
56
To run the simulator in docker container

spaceros/README.md

+11-5
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ To build the image, run:
1515

1616
The build process will take about 20 or 30 minutes, depending on the host computer.
1717

18-
The build process defaults to cloning the `ros2.repos` file from [spaceros](https://github.com/space-ros/space-ros) repository. It looks for a branch with the same name as the current local branch; if it doesn't find one, it falls back to cloning from the main branch. For testing purposes, you can customize both the spaceros repository URL and the branch name by modifying arguments defined in the [Earthfile](./Earthfile).
18+
The build process defaults to cloning the `ros2.repos` file from [spaceros](https://github.com/space-ros/space-ros) repository.
19+
It looks for a branch with the same name as the current local branch; if it doesn't find one, it falls back to cloning from the main branch.
20+
For testing purposes, you can customize both the spaceros repository URL and the branch name by modifying arguments defined in the [Earthfile](./Earthfile).
1921
Example:
2022
```bash
2123
earthly +image --SPACEROS_REPO_URL="https://github.com/my-org/my-spaceros-fork.git" --SPACEROS_GIT_REF="my-branch-name"
@@ -107,15 +109,17 @@ spaceros-user@d10d85c68f0e:~/spaceros$ colcon test --ctest-args -LE "(ikos|xfail
107109

108110
The tests include running the static analysis tools clang_tidy and cppcheck (which has the MISRA 2012 add-on enabled).
109111

110-
You can use colcon's `--packages-select` option to run a subset of packages. For example, to run tests only for the rcpputils package and display the output directly to the console (as well as saving it to a log file), you can run:
112+
You can use colcon's `--packages-select` option to run a subset of packages.
113+
For example, to run tests only for the rcpputils package and display the output directly to the console (as well as saving it to a log file), you can run:
111114

112115
```
113116
spaceros-user@d10d85c68f0e:~/spaceros$ colcon test --event-handlers console_direct+ --packages-select rcpputils
114117
```
115118

116119
## Viewing Test Output
117120

118-
The output from the tests are stored in XUnit XML files, named *\<tool-name\>*.xunit.xml. After running the unit tests, you can scan the build directory for the various *\*.xunit.xml* files.
121+
The output from the tests are stored in XUnit XML files, named *\<tool-name\>*.xunit.xml.
122+
After running the unit tests, you can scan the build directory for the various *\*.xunit.xml* files.
119123

120124
For example, a clang_tidy.xunit.xml file looks like this:
121125

@@ -181,7 +185,8 @@ CONTAINER ID IMAGE COMMAND CREATED
181185
d10d85c68f0e openrobotics/spaceros "/entrypoint.sh …" 28 minutes ago Up 28 minutes inspiring_moser
182186
```
183187

184-
The container ID in this case, is *d10d85c68f0e*. So, run the following command in the host terminal:
188+
The container ID in this case, is *d10d85c68f0e*.
189+
So, run the following command in the host terminal:
185190

186191
```bash
187192
docker exec -it d10d85c68f0e /bin/bash --init-file "install/setup.bash"
@@ -223,7 +228,8 @@ spaceros-user@d10d85c68f0e:~/spaceros$ colcon test --build-base build_ikos --ins
223228
```
224229

225230
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:
231+
After running `colcon test`, you can view the JUnit XML files.
232+
For example, to view the JUnit XML file for IKOS scan of the rcpputils binaries you can use the following command:
227233

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

zynq_rtems/README.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44

55
The goal is to create an hard real-time embedded application that runs on a Xilinx Zynq SoC FPGA which will communicate with Space-ROS.
66

7-
This demonstration will be on [QEMU](https://www.qemu.org), the open-source CPU and system emulator. This is for several reasons:
7+
This demonstration will be on [QEMU](https://www.qemu.org), the open-source CPU and system emulator.
8+
This is for several reasons:
89
* Development cycles in QEMU are much faster and less painful than hardware.
910
* Given the state of the semiconductor industry at time of writing (late 2022), it is nearly impossible to obtain Zynq development boards.
1011
* QEMU-based work requires no upfront hardware costs or purchasing delays
@@ -58,7 +59,8 @@ cd /path/to/zynq_rtems
5859
cd hello_zenoh
5960
./run_zenoh_router
6061
```
61-
This will print a bunch of startup information and then continue running silently, waiting for inbound Zenoh traffic. Leave this terminal running.
62+
This will print a bunch of startup information and then continue running silently, waiting for inbound Zenoh traffic.
63+
Leave this terminal running.
6264

6365
In the second terminal, we'll run the Zenoh subscriber example:
6466

@@ -78,7 +80,8 @@ cd hello_zenoh
7880
```
7981

8082
The terminal should print a bunch of information about the various emulated Zynq network interfaces and their routing information.
81-
After that, it should contact the `zenohd` instance running in the other terminal. It should print something like this:
83+
After that, it should contact the `zenohd` instance running in the other terminal.
84+
It should print something like this:
8285

8386
```
8487
Opening zenoh session...

0 commit comments

Comments
 (0)