Skip to content

Commit

Permalink
Add usage guidelines
Browse files Browse the repository at this point in the history
Signed-off-by: Ryan Friedman <ryanfriedman5410+github@gmail.com>
  • Loading branch information
Ryanf55 committed Feb 27, 2024
1 parent 9976ff8 commit c2b63cc
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
1 change: 1 addition & 0 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,7 @@ endif()

# Export old-style CMake variables for includes
ament_export_include_directories("include/${PROJECT_NAME}")
ament_export_libraries(${interface_targets} ${plugin_targets})

# Export modern CMake targets
ament_export_targets(export_${PROJECT_NAME} HAS_LIBRARY_TARGET)
Expand Down
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Filters

## Usage with ament_cmake

Here is recommended approach on how to link `filters` to your project, using the `filter_base` target.

```cmake
find_package(filters CONFIG REQUIRED)
add_library(my_library)
# Other library stuff here
target_link_libraries(my_library PUBLIC filters::filter_base)
```

Do NOT use the `filters_LIBRARIES` anymore.

For more information,
see the [ament_cmake](https://docs.ros.org/en/rolling/How-To-Guides/Ament-CMake-Documentation.html)
tutorial.

0 comments on commit c2b63cc

Please sign in to comment.