Skip to content

README.md

Latest commit

 

History

History
130 lines (97 loc) · 2.83 KB

README.md

File metadata and controls

130 lines (97 loc) · 2.83 KB

cppbox

Collection of general-purpose C++ functions, classes and utilities

Core Library

Dependency Version Description
CMake >= 3.21 CMake Build Tool
cmakebox >= 0.0.11 CMake Functions and Utilities

There are several ways to include cppbox within your project:

  • [Preferred] Via FetchContent allowing package to be built as a submodule.
  • Via find_package, requiring package to be installed to the system, locally, or to a catkin workspace.

Include via FetchContent

It is recommended to leverage the functionality of cmakebox by including the following lines in the CMakeLists.txt (replace X.Y.Z with versions for each):

set(CMAKEBOX_VERSION "X.Y.Z")
FetchContent_Declare(
    cmakebox
    GIT_REPOSITORY git@github.com:willat343/cmakebox.git
    GIT_TAG v${CMAKEBOX_VERSION}
)
FetchContent_MakeAvailable(cmakebox)
list(APPEND CMAKE_MODULE_PATH "${cmakebox_SOURCE_DIR}/cmake")
include(CMakeBox)

set(CPPBOX_VERSION "X.Y.Z")
import_dependency(
    cppbox
    TARGET cppbox::cppbox
    VERSION ${CPPBOX_VERSION}
    GIT_REPOSITORY git@github.com:willat343/cppbox
    GIT_TAG v${CPPBOX_VERSION}
)

Without relying on cmakebox, this can be achieved with (replace X.Y.Z with version):

set(CPPBOX_VERSION "X.Y.Z")
FetchContent_Declare(
    cppbox
    GIT_REPOSITORY git@github.com:willat343/cppbox
    GIT_TAG        v${CPPBOX_VERSION}
)
FetchContent_MakeAvailable(cppbox)

Include via Install

Clone

git clone git@github.com:willat343/cppbox.git
cd cppbox

Configure

cmake -G Ninja -S . -B build

For local install add -DCMAKE_INSTALL_DIR=$HOME/.local.

Build

cmake --build build -j

Install

sudo cmake --build build --target install

Include

Include with the following lines in the CMakeLists.txt:

find_package(cppbox REQUIRED)
target_link_libraries(<target> PUBLIC cppbox::cppbox)

Uninstall

sudo cmake --build build --target uninstall

Include in Catkin Workspace

A package.xml is supplied to facilitate an isolated installation within a catkin workspace (e.g. for ROS applications).

Clone

cd /path/to/catkin_ws/src
git clone git@github.com:willat343/cppbox.git

Build

cd /path/to/catkin_ws
catkin build cppbox

Include

To use the package in a downstream project, one should add to their package.xml:

<depend>cppbox</depend>

One can then include cppbox package by including in the CMakeLists.txt:

find_package(cppbox REQUIRED)
target_link_libraries(<target> PUBLIC cppbox::cppbox)

Clean

cd /path/to/catkin_ws
catkin clean cppbox