From 6965d9e4f46fa036f2067271f8790981ca2d8eb9 Mon Sep 17 00:00:00 2001 From: Chris Thrasher Date: Wed, 6 Dec 2023 15:40:00 -0700 Subject: [PATCH] Document API changes from v0 to v1 --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 9e371d3..2869ebc 100644 --- a/README.md +++ b/README.md @@ -21,3 +21,9 @@ Read the docs [here](https://picknikrobotics.github.io/RSL/files.html). * [static_vector.hpp](include/rsl/static_vector.hpp) - Static capacity vector class * [strong_type.hpp](include/rsl/strong_type.hpp) - Strong typedef class * [try.hpp](include/rsl/try.hpp) - Macro to emulatate absl::CONFIRM or operator? from Rust + +## v0 -> v1 API Breaks + +No C++ API changes were made between version 0 and version 1 but a change to the build interface was made. +Because we stopped using Ament CMake macros, you cannot use `ament_target_dependencies` to link to RSL. +You must instead use `target_link_libraries(... rsl::rsl)` as you would any other non-ament CMake package.