Skip to content

Commit 3bdf025

Browse files
Explain where the .meta packages are located and how to edit them (#868) Backport
* 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 6438e66 commit 3bdf025

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
@@ -152,6 +152,8 @@ An example of a micro-ROS application using PlatformIO is available [here](https
152152
153153
## How to build the precompiled library
154154
155+
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:
156+
155157
```bash
156158
docker pull microros/micro_ros_static_library_builder:rolling
157159
docker run -it --rm -v $(pwd):/project --env MICROROS_LIBRARY_FOLDER=extras microros/micro_ros_static_library_builder:rolling
@@ -165,7 +167,10 @@ docker run -it --rm -v $(pwd):/project --env MICROROS_LIBRARY_FOLDER=extras micr
165167

166168
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)
167169

168-
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.
170+
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.
171+
This should be used for example when adding custom messages types or custom micro-ROS packages.
172+
173+
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.
169174

170175
## Patch Arduino board for support precompiled libraries
171176
### Patch Teensyduino

0 commit comments

Comments
 (0)