Skip to content

Commit b40a9c3

Browse files
Explain where the .meta packages are located and how to edit them (#868)
* Explain where the .meta packages are located and how to edit them * Apply suggestions from code review * Update README.md Co-authored-by: Pablo Garrido <[email protected]>
1 parent ae2db85 commit b40a9c3

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,8 @@ An example of a micro-ROS application using PlatformIO is available [here](https
173173
174174
## How to build the precompiled library
175175
176+
If you need to add custom packages or types, or customize any internal parameter of the micro-ROS stack, you will need to recompile this library from source code:
177+
176178
```bash
177179
docker pull microros/micro_ros_static_library_builder:galactic
178180
docker run -it --rm -v $(pwd):/project --env MICROROS_LIBRARY_FOLDER=extras microros/micro_ros_static_library_builder:galactic
@@ -186,7 +188,10 @@ docker run -it --rm -v $(pwd):/project --env MICROROS_LIBRARY_FOLDER=extras micr
186188

187189
Available targets `LIBRARY_TARGETS` are available on the [top of the extras/library_generation/library_generation.sh file](https://github.com/micro-ROS/micro_ros_arduino/blob/main/extras/library_generation/library_generation.sh#L13-L24)
188190

189-
Note that folders added to `extras/library_generation/extra_packages` and entries added to `extras/library_generation/extra_packages/extra_packages.repos` will be taken into account by this build system.
191+
Folders added to `extras/library_generation/extra_packages` and entries added to `extras/library_generation/extra_packages/extra_packages.repos` will be taken into account by this build system.
192+
This should be used for example when adding custom messages types or custom micro-ROS packages.
193+
194+
You can [configure many parameters](https://micro.ros.org/docs/tutorials/advanced/microxrcedds_rmw_configuration/) of the library by editing the respective `.meta` file in the `extras/library_generation/` directory.
190195

191196
## Patch Arduino board for support precompiled libraries
192197
### Patch Teensyduino

0 commit comments

Comments
 (0)