GavinNL / cpp_library_template

A template to build C++ libraries with autogenerated find_package() and conan integration

C++ Library Template

This is a C++ Library Template using modern CMake. It's list file is modified from https://github.com/forexample/package-example.

Branch	Gitlab-CI
dev
master

Features

• Multimodule library: Three libraries wrapped in a single namespace: foo::bar, foo::cat and foo::dog
• Auto-generated EXPORT headers for Windows DLLs
• Auto-generated CMake config files for installation
• Unit tests
• Conan Package Manager Integration
• Gitlab-CI integration
  • Builds the library with gcc/clang verions
  • Tests that the find_package() method works
  • Builds the Conan Package
  • Tests the cmake, cmake_paths, and cmake_find_package generators work
• [to do] CPack generation.

Compiling

# Build, test and install the library
git clone https://github.com/GavinNL/cpp_library_template
cd cpp_library_template
mkdir build && cd build
cmake .. -DCMAKE_INSTALL_PREFIX=/tmp/cpp_library_template -DBUILD_SHARED_LIBS:BOOL=TRUE
cmake --build .
ctest -C Debug
cmake --build . --target install

# Build an application that links to this one using.
# Use the find_package(foo) method to find where the installation
# is.
cd ..
rm -rf build
cd test_cmake_install

mkdir build && cd build
cmake .. -DCMAKE_PREFIX_PATH=/tmp/cpp_library_template
cmake --build .

export LD_LIBRARY_PATH=/tmp/cpp_library_template/lib
./test-bar
./test-cat

Conan Package Manager

This library comes with a conanfile.py to build it into a Conan package so that it may be used by external applications/libraries.

Create Conan Packages

Creating a Conan package is relatively easy. Simple cd into the source directory and execute the conan create function.

git clone https://github.com/GavinNL/cpp_library_template
cd cpp_library_template

conan create . foo/testing

Using the Conan Package

Once you have created the Conan package, you can then link to it from another application or library. There are three examples you can look at in the test_cmake_install folder.

• Using cmake generator
• Using cake_paths generator
• Using cmake_find_package generator