Skip to content

Latest commit

 

History

History
35 lines (23 loc) · 1 KB

README.md

File metadata and controls

35 lines (23 loc) · 1 KB

Geometry Common

build status

Common data structures, utilities and modules for geometric tasks.

Documentation

We use Doxygen for code documentation.

Note: Building the documentation is disabled by default.

  • To build the code documentation, Doxygen needs to be installed. On debian based systems, this can be achieved with

    sudo apt install doxygen
  • Documentation can be built using the flag -DBUILD_DOC=ON

    catkin build geometry_common -DBUILD_DOC=ON
  • The documentation will be generated at <YOUR_CATKIN_WS>/build/geometry_common/docs/html/index.html

Test

Run unit tests with

catkin build --this --catkin-make-args run_tests -- && rosrun geometry_common geometry_common_test

Note: Requires GTest package (sudo apt install libgtest-dev)