Skip to content

Commit

Permalink
Document API changes from v0 to v1
Browse files Browse the repository at this point in the history
  • Loading branch information
ChrisThrasher committed Dec 6, 2023
1 parent b63f048 commit 6965d9e
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit 6965d9e

Please sign in to comment.