=================== CMake BASIS Modules

This directory/repository contains the CMake modules of the CMake BASIS project. These modules are required by any project which takes advantage of the extended CMake BASIS commands. Other components of CMake BASIS such as the CMake BASIS Utilities (a library of common functions for each supported programming language) and the CMake BASIS Tools (e.g., the mad-libs style basisproject tool) are part of the complete CMake BASIS project.

License

The CMake BASIS Modules are distributed under the OSI-approved BSD License. See accompanying file COPYING.txt for details.

This software is distributed WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the License for more information.

Installation

Developers requiring only the CMake BASIS Modules are encouraged to include the CMake BASIS Modules files directly in their own Git controlled project source tree, either as Git subtree or (shallow) submodule.

To only utilize these modules, we recommend the use of the basis-modules project template instead of the basis template which requires a separate build of the entire CMake BASIS project.

TODO: Add basis-modules project template to CMake BASIS and link them here.

Using CMake modules as subtree (recommended)

To add the CMake BASIS Modules as subtree to your project under the subdirectory path basis/, use the following two commands. The first adds a new remote which simplifies the consecutive commands:

git remote add -f basis-modules https://github.com/cmake-basis/modules.git
git subtree add --prefix=basis basis-modules master --squash

In order to update the modules at a later time to incorporate changes of the CMake BASIS Modules into your project, use the following commands:

git fetch basis-modules master
git subtree pull --prefix=basis basis-modules master --squash

Adding CMake modules as submodule

An alternative to the git subtree command to add the CMake BASIS Modules to your project, you can use git submodule instead. For a comparison of the two commands and their ups and downs, read some of the many tutorials available online.

To add the CMake BASIS Modules as submodule to your project under the subdirectory path basis/, use the following commands. The .gitmodules file which records the added submodules and the URL of the remote repository must be committed to your project.

git submodule add --depth=1 https://github.com/cmake-basis/modules.git basis
git add .gitmodules
git commit -m 'add: CMake BASIS Modules'

In order to update the modules at a later time to incorporate changes of the CMake BASIS Modules into your project, use the following commands:

cd basis/                                        # change to submodule directory
git checkout master                              # checkout master branch
git pull                                         # pull remote changes
cd ..                                            # change back to main repository
git add basis                                    # stash change of submodule SHA
git commit -m 'mod: Update CMake BASIS Modules'  # commit submodule change

First, you have to pull the changes from the remote repository and merge them into your local submodule repository. Then you have to update the submodule commit SHA recorded in your main repository to point to the latest commit of the CMake BASIS Modules.