https://github.com/flagarde/cmakemm
📦 CMake Modules Manager
https://github.com/flagarde/cmakemm
cmake module-manager
Last synced: about 2 months ago
JSON representation
📦 CMake Modules Manager
- Host: GitHub
- URL: https://github.com/flagarde/cmakemm
- Owner: flagarde
- License: mit
- Created: 2020-10-22T14:01:25.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2026-02-26T10:27:46.000Z (about 2 months ago)
- Last Synced: 2026-02-26T16:22:30.538Z (about 2 months ago)
- Topics: cmake, module-manager
- Language: CMake
- Homepage: https://flagarde.github.io/docs/CMakeMM
- Size: 331 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: Changelog.cmake
- License: LICENSE
Awesome Lists containing this project
README
MOVED TO https://github.com/cmake-tools/cmmm
CMakeMM
CMake Modules Manager.
[](https://www.codacy.com/gh/flagarde/CMakeMM/dashboard?utm_source=github.com&utm_medium=referral&utm_content=flagarde/CMakeMM&utm_campaign=Badge_Grade)
[](https://github.com/flagarde/CMakeMM/actions/workflows/Docs.yml)
```text
📖 Documentation
```
## Tests
| Linux | MacOS | Windows |
|:-----------------:|:-----------------:|---------------------|
| [![Linux][lb]][l] | [![MacOS][mb]][m] | [![Windows][wb]][w] |
## ✨ Introduction
This repository's main product is the GetCMakeMM.cmake file in the repository root. It downloads CMakeMM which in turn download the list of modules available for download and consumption.
## ❓ How to use CMakeMM
### 1️⃣ Download `GetCMakeMM.cmake`
To use `CMakeMM` you have to download the latest [`GetCMakeMM.cmake`](https://github.com/flagarde/CMakeMM/blob/master/GetCMakeMM.cmake) and put it in a place CMake can find it.
### 2️⃣ Use `GetCMakeMM.cmake` in your `CMakeLists.txt`
```cmake
set(CMAKE_MODULE_PATH "${CMAKE_MODULE_PATH}" "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
include(GetCMakeMM)
cmmm(VERSION "2.0"
REPOSITORY "flagarde/CMakeMM"
VERBOSITY VERBOSE
DESTINATION "CMakeMM"
ALWAYS_DOWNLOAD)
```
*Will download `CMakeMM` from the release version `1.0` in flagarde/CMakeMM repository under `CMakeMM` folder.*
**Options :**
- `PROVIDER` : From where to download CMakeMM (GitHub, gitlab or gitee).
- `ALWAYS_DOWNLOAD` : Always download the CMakeMM files.
- `NO_COLOR` : Turn out the color.
- `REPOSITORY` : Repository where to download CMakeMM.
- `VERSION` : Version of CMakeMM to download.
- `DESTINATION` : Where to install CMakeMM.
- `TIMEOUT` : Terminate the operation after a given total time has elapsed.
- `INACTIVITY_TIMEOUT` : Terminate the operation after a period of inactivity.
- `VERBOSITY` : Verbosity of CMakeMM `NOTICE`, `STATUS`, `VERBOSE`, `DEBUG` and `TRACE`.
- `IGNORE_NEW_VERSION` : Ignore new versions of `CMakeMM`.
### 3️⃣ Tell to `CMakeMM` where to find the modules list and where to save the modules
```cmake
cmmm_modules_list(URL "https://raw.githubusercontent.com/flagarde/CMakeCM/main/ModulesList.cmake"
BRANCH master
FOLDER modules
FILENAME ModuleLists
DESTINATION "Modules")
```
*Will download the module list file called `ModuleLists.cmake` in folder `modules` on branch `master` from the GitHub depot `https://raw.githubusercontent.com/SDHCAL/SDHCALCMakeModules`*.
**Options :**
- `ALWAYS_DOWNLOAD` : Always download the Modules List.
- `URL` : URL where to download the Modules List (`https://raw.githubusercontent.com/flagarde/CMakeMM` per default).
- `REPOSITORY` : GitHub repository to download the Modules List (`flagarde/CMakeCM` for example).
- `PROVIDER` : From where to download CMakeMM (GitHub, gitlab or gitee).
- `BRANCH` : Branch where to download the Modules List (`master` per default).
- `FOLDER` : Folder where to download the Modules List.
- `FILENAME` : Name of the Modules List file.
- `DESTINATION` : Where to install the Modules.
### 4️⃣ Include the modules you need
```cmake
include(MyWonderfulModule)
```
*Will download the module `MyWonderfulModule.cmake` is it's not present in the `CMAKE_MODULE_PATH` folders or `Modules` folder, then include it. Otherwise, it will just include it.*
## ⚗ Example
CMakeLists.txt :
```cmake
cmake_minimum_required(VERSION 3.10...3.17.2 FATAL_ERROR)
project(MySoftware
VERSION "0.0.1.0"
DESCRIPTION "MySoftware"
HOMEPAGE_URL "https://github.com/flagarde/MySoftware"
LANGUAGES CXX)
set(CMAKE_MODULE_PATH "${CMAKE_MODULE_PATH}" "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
include(GetCMakeMM)
cmmm(VERSION "2.0"
REPOSITORY "flagarde/CMakeMM"
VERBOSITY VERBOSE
DESTINATION "CMakeMM"
ALWAYS_DOWNLOAD)
cmmm_modules_list(URL "https://raw.githubusercontent.com/SDHCAL/SDHCALCMakeModules"
BRANCH main
DESTINATION "Modules")
# Now download the modules
include(Colors)
```
## 📝 Create a Modules List
Modules can be `LOCALE` or `REMOTE` :
### ➕ Adding a "Local" Module
Local modules are contained within the repository given by `URL` in `cmmm_modules_list`. If you do not wish to own a separate repository to contain the module, this is the recommended way to do so.
To start, add a module in the repository. This will be the module that will be included by the user. It should consist of a single CMake file.
After adding the module, add a call to `cmcm_module` in the Modules List.
Suppose you add a `SuperCoolModule.cmake` to `modules`. The resulting call in `modules/ModulesList.cmake` will look something like this :
```cmake
cmcm_module(SuperCoolModule.cmake LOCAL modules/SuperCoolModule.cmake VERSION 1)
```
The `VERSION` argument is an arbitrary string that is used to invalidate local copies of the module that have been downloaded.
*The path to the LOCAL module is taken from the `root` of the `Git` `branch`, not the relative path of the `FOLDER` argument in `cmmm_modules_list`.*
### ➕ Adding a "Remote" Module
If you have a module that you wish to add, but it is contained in a remote location, you simply need to add the call in the Modules List :
```cmake
cmcm_module(MyAwesomeModule.cmake
REMOTE https://some-place.example.com/files/path/MyAwesomeModule.cmake
VERSION 1)
```
The `VERSION` argument is an arbitrary string that is used to invalidate local copies of the module that have been downloaded.
The `REMOTE` is a `URL` to the file to download for the module. In order for your modification to be accepted into the repository, it must meet certain criteria :
1. The URL *must* use `https`.
2. The URL *must* refer to a stable file location. If using a `Git URL`, it should refer to a specific commit, not to a branch.
[l]: https://github.com/flagarde/CMakeMM/actions/workflows/Linux.yml
[lb]: https://github.com/flagarde/CMakeMM/actions/workflows/Linux.yml/badge.svg
[m]: https://github.com/flagarde/CMakeMM/actions/workflows/MacOS.yml
[mb]: https://github.com/flagarde/CMakeMM/actions/workflows/MacOS.yml/badge.svg
[w]: https://github.com/flagarde/CMakeMM/actions/workflows/Windows.yml
[wb]: https://github.com/flagarde/CMakeMM/actions/workflows/Windows.yml/badge.svg