CPM.cmake 使用教程

1. 项目介绍

CPM.cmake 是一个跨平台的 CMake 脚本，为 CMake 添加了依赖管理功能。它构建在 CMake 的 FetchContent 模块之上，提供了版本控制、缓存、简单的 API 等功能。CPM.cmake 的目标是简化 C++ 项目中第三方依赖的引入和管理，使开发者能够轻松地将所需的第三方库集成到项目中，而无需手动下载、配置和管理这些库。

2. 项目快速启动

2.1 安装 CPM.cmake

首先，将 CPM.cmake 添加到你的项目中。你可以通过以下命令自动完成这一步骤：

mkdir -p cmake
wget -O cmake/CPM.cmake https://github.com/cpm-cmake/CPM.cmake/releases/latest/download/get_cpm.cmake

2.2 在项目中使用 CPM.cmake

在你的 CMakeLists.txt 文件中，添加以下内容以使用 CPM.cmake：

cmake_minimum_required(VERSION 3.14 FATAL_ERROR)

# 创建项目
project(MyProject)

# 添加可执行文件
add_executable(main main.cpp)

# 添加依赖
include(cmake/CPM.cmake)

# 使用 CPMAddPackage 添加依赖库
CPMAddPackage("gh:fmtlib/fmt#7.1.3")
CPMAddPackage("gh:nlohmann/json@3.10.5")
CPMAddPackage("gh:catchorg/Catch2@3.4.0")

# 链接依赖库
target_link_libraries(main fmt::fmt nlohmann_json::nlohmann_json Catch2::Catch2WithMain)

2.3 构建项目

使用以下命令构建你的项目：

mkdir build
cd build
cmake ..
make

3. 应用案例和最佳实践

3.1 使用 CPM.cmake 管理复杂依赖

在大型项目中，依赖管理可能会变得非常复杂。CPM.cmake 通过版本控制和缓存功能，确保项目的依赖始终是最新的，并且可以在离线状态下进行构建。

CPMAddPackage(
    NAME Boost
    VERSION 1.84.0
    URL https://github.com/boostorg/boost/releases/download/boost-1.84.0/boost-1.84.0.tar.xz
    URL_HASH SHA256=2e64e5d79a738d0fa6fb546c6e5c2bd28f88d268a2a080546f74e5ff98f29d0e
    OPTIONS "BOOST_ENABLE_CMAKE ON"
)

3.2 使用 CPM.cmake 进行跨平台开发

CPM.cmake 支持跨平台开发，确保在不同操作系统上都能一致地管理依赖。

CPMAddPackage("gh:catchorg/Catch2@2.5.0")

4. 典型生态项目

以下是一些使用 CPM.cmake 的典型项目：

• OTTO - 开源的 GrooveBox 项目。
• Maphi - 数学应用程序。
• ModernCppStarter - 现代 C++ 项目启动器。
• liblava - 现代 Vulkan 图形库。
• klogg - 快速的高级日志浏览器。

这些项目展示了 CPM.cmake 在实际应用中的强大功能和灵活性。