diff --git a/README.md b/README.md index ed9b832..8b0680b 100644 --- a/README.md +++ b/README.md @@ -71,14 +71,14 @@ First make sure we have run the unit test already. colcon test ``` -### Test coverage report for "my_controller": +### Test coverage report for `my_controller`: ``` bash ros2 run my_controller generate_coverage_report.bash open build/my_controller/test_coverage/index.html ``` -### Test coverage report for "my_model": +### Test coverage report for `my_model`: ``` bash colcon build \ diff --git a/src/my_controller/README.md b/src/my_controller/README.md index f1ae8cd..e566a3f 100644 --- a/src/my_controller/README.md +++ b/src/my_controller/README.md @@ -1,4 +1,4 @@ -# my_controller +# `my_controller` Here's a simple ROS2 package that demonstrates how integration test (aka level 2 unit test) can be done using GoogleTest. @@ -14,11 +14,26 @@ For a more portable ROS2 integration test framework, consider using catch_ros2: https://github.com/ngmor/catch_ros2 -This ROS2 package depends on the "my_model" module. This dependency -is specified in the package's package.xml file: +This ROS2 package depends on the `my_model` module. This dependency +is specified in the package's `package.xml` file: ``` my_model ``` +Alternatively, we could also specify the dependency by creating a +`colcon.pkg` file with the content listed below. But since this is a +ROS package, we must use `package.xml` instead of `colcon.pkg`. +Otherwise the package will not show up in the list of ROS2 packages +(ie., output of `ros2 pkg list`). + +``` +{ + "name": "my_controller", + "type": "cmake", + "dependencies" : ["my_model"] +} +``` + + diff --git a/src/my_model/README.md b/src/my_model/README.md index 82e8d15..53eae32 100644 --- a/src/my_model/README.md +++ b/src/my_model/README.md @@ -1,4 +1,4 @@ -# my_model +# `my_model` ## Overview