search

ament / ament_cmake

Supporting CMake packages for working with ament
Apache License 2.0
97 stars 123 forks source link

Documentation for ament_cmake_auto #288

Open nnmm opened 3 years ago

nnmm commented 3 years ago

I like that ament_cmake_auto can potentially eliminate a lot of boilerplate. However, I've not been able to find any documentation for it besides three examples at the bottom of this article: https://design.ros2.org/articles/ament.html. I found it not to be self-explanatory in all cases, and those examples are already five years old. Is ament_cmake_auto documented somewhere, and if not, will it be at some point in the future?

hidmic commented 3 years ago

Is ament_cmake_auto documented somewhere

Not that I'm aware of.

if not, will it be at some point in the future?

AFAIK it's not in the roadmap. But contributions are most welcomed. If you're willing to submit a PR, we can refine it together.

nnmm commented 3 years ago

Thanks for being so quick to get back to me! I might in the future, but for now it's fine if you prefer to close this issue.

hidmic commented 3 years ago

I'll keep it around. Maybe someone wants to pick it up at some point.

tylerjw commented 3 years ago

I'm just here to leave a +1 to this by saying that from the examples it looks like ament_auto could be really useful.

I mostly want an official guide to the right way (tm) for using ament_cmake. I'd be willing to help with making PRs for this documentation, where should I make these PRs?

hidmic commented 3 years ago

API documentation should live in this repository. Tutorials and guides go to ros2_documentation.

miferco97 commented 1 year ago

Hello, perhaps including references to ament_auto in the Ament-CMake Documentation within the ROS 2 docs would help raise awareness among more people. Currently, it seems hidden for ROS 2 newcomers, who I believe would greatly appreciate having access to these CMake macros when creating their initial projects.