Skip to content

Latest commit

 

History

History
56 lines (46 loc) · 1.95 KB

README.md

File metadata and controls

56 lines (46 loc) · 1.95 KB
Raw

Introduction

This module offers a set of CMake helpers that can be use to ease several tasks while defining a project.

Features

Currently, the available features are:

  • CMakeModules: This feature is a large set of helpers offered by an external developer named Ryan Palvik.

  • Externals: This feature helps to build external dependencies.

  • Miscellaneaous: This feature is a library of helpers to ease definition and integration of self defined projects.

Usage

To use this set of helpers, some modifications are needed in the CMake based project. This is performed through two steps:

Reference sub-module

In order for the targeted CMake based Project to use CMakeBuildSystem's helpers, it must first reference it.

This is easily performed thanks to git's submodule feature:

# Go to the project's root path
cd targeted_project

# Add CMakeBuildSystem sub-module.
# Note
#   We choose, here, to link sub-module under path 'cmake-build-system' located in the root
#   of the project.
git submodule add -b master "https://github.com/securesocketfunneling/cmake-build-system.git" cmake-build-system

# Ensure all CMakeBuildSystem's sub-modules are checked-out
git submodule update --init --recursive cmake-build-system

Update Modules Search Path

Once the CMakeBuildSystem module is available from the targeted project's source tree, it must be initialized from a CMakeLists.txt list of the project. Just add the following lines:

# Initialize sub-module CMakeBuildSystem that is linked on project's root
add_subdirectory(${CMAKE_SOURCE_DIR}/cmake-build-system)

Note

It is recommended to initialize the CMakeBuildSystem module from the root CMakeLists.txt file. That will ensure the module's helpers are available to all of the other project's CMakeLists.txt files.