https://github.com/TheLartians/PackageProject.cmake

🏛️ Help other developers use your project. A CMake script for packaging C/C++ projects for simple project installation while employing best-practices for maximum compatibility.
https://github.com/TheLartians/PackageProject.cmake

best-practices c cmake cpp dependency export install installation managemant namespace package packaging target

Last synced: 3 months ago
JSON representation

🏛️ Help other developers use your project. A CMake script for packaging C/C++ projects for simple project installation while employing best-practices for maximum compatibility.

• Host: GitHub
• URL: https://github.com/TheLartians/PackageProject.cmake
• Owner: TheLartians
• License: mit
• Created: 2020-04-14T10:05:51.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-01-17T07:45:06.000Z (10 months ago)
• Last Synced: 2024-06-12T05:42:07.965Z (5 months ago)
• Topics: best-practices, c, cmake, cpp, dependency, export, install, installation, managemant, namespace, package, packaging, target
• Language: CMake
• Homepage:
• Size: 39.1 KB
• Stars: 97
• Watchers: 9
• Forks: 15
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Test](https://github.com/TheLartians/PackageProject.cmake/workflows/Test/badge.svg)

# PackageProject.cmake

Creating installable CMake scripts always requires a large amount of boilerplate code to get things working.

This small script should simplify the CMake packaging process into a single, easy-to-use command.

PackageProject.cmake has been tested with CMake v3.18.4.

## Usage

To create an installable target for your current project, add the following to your CMakeLists.txt.

This example assumes the project to be versioned and the name to be identical to the library to export.

Also the [CPM.cmake](https://github.com/TheLartians/CPM.cmake) script should be included.

See [here](https://github.com/TheLartians/ModernCppStarter/blob/master/CMakeLists.txt) for an example usage.

```cmake

CPMAddPackage("gh:TheLartians/[email protected]")

packageProject(

  # the name of the target to export

  NAME ${PROJECT_NAME}

  # the version of the target to export

  VERSION ${PROJECT_VERSION}

  # a temporary directory to create the config files

  BINARY_DIR ${PROJECT_BINARY_DIR}

  # location of the target's public headers

  INCLUDE_DIR ${PROJECT_SOURCE_DIR}/include

  # should match the target's INSTALL_INTERFACE include directory

  INCLUDE_DESTINATION include/${PROJECT_NAME}-${PROJECT_VERSION}

  # (optional) option to install only header files with matching pattern

  INCLUDE_HEADER_PATTERN "*.h"

  # semicolon separated list of the project's dependencies

  DEPENDENCIES "fmt 7.1.3;cxxopts 2.2.0"

  # (optional) create a header containing the version info

  # Note: that the path to headers should be lowercase

  VERSION_HEADER "${PROJECT_NAME}/version.h"

  # (optional) create a export header using GenerateExportHeader module

  EXPORT_HEADER "${PROJECT_NAME}/export.h"

  # (optional) install your library with a namespace (Note: do NOT add extra '::')

  NAMESPACE ${PROJECT_NAMESPACE}

  # (optional) define the project's version compatibility, defaults to `AnyNewerVersion`

  # supported values: `AnyNewerVersion|SameMajorVersion|SameMinorVersion|ExactVersion`

  COMPATIBILITY AnyNewerVersion

  # (optional) option to disable the versioning of install destinations

  DISABLE_VERSION_SUFFIX YES

  # (optional) option to ignore target architecture for package resolution

  # defaults to YES for header only (i.e. INTERFACE) libraries

  ARCH_INDEPENDENT YES

  # (optional) option to generate CPack variables

  CPACK YES

)

```

## CPack

We provide only the most basic variables for CPack generation, however this might not be enough

for each and every generator.

For example, Debians' DEB generator needs additionally [`CPACK_DEBIAN_PACKAGE_MAINTAINER`](https://cmake.org/cmake/help/latest/cpack_gen/deb.html#variable:CPACK_DEBIAN_PACKAGE_MAINTAINER) or a `CPACK_PACKAGE_CONTACT`:

```cmake

set(CPACK_DEBIAN_PACKAGE_MAINTAINER "Foo Bar ")

```

If you need extra functionality feel free to open an issue or a PR.