将腐蚀(Corrosion)添加到你的项目

腐蚀(Corrosion)支持两种基本的安装方法:作为 CMake 包安装或作为现有 CMake 项目的子目录使用。对于 CMake 3.19 以下版本,强烈建议通过包管理器或手动使用 CMake 的安装工具来安装包。如果你有 CMake 3.19 或更新版本,我们建议使用 FetchContentSubdirectory 方法来集成腐蚀(Corrosion)。

FetchContent

如果你使用的是 CMake >= 3.19,或者在你的环境安装困难或不可行,你可以使用 FetchContent 模块来包含腐蚀(Corrosion)。这将在配置时下载腐蚀(Corrosion)并像子目录一样使用它。

在你的 CMakeLists.txt 中:

  1. include(FetchContent)
  2. FetchContent_Declare(
  3. Corrosion
  4. GIT_REPOSITORY https://github.com/corrosion-rs/corrosion.git
  5. GIT_TAG v0.4 # 这里可以指定一个特定的提交哈希、版本标签或分支
  6. )
  7. # 在这行之前设置任何全局配置变量,比如 `Rust_TOOLCHAIN`
  8. FetchContent_MakeAvailable(Corrosion)

Subdirectory

腐蚀(Corrosion)也可以直接作为子目录使用。这种解决方案可能适用于小型项目,但不建议用于具有许多依赖项的大型项目,特别是那些可能自己使用腐蚀(Corrosion)的项目。将腐蚀(Corrosion)库复制到你的源代码树中,确保保留 LICENSE 文件,或者将这个仓库添加为 git 子模块:

  1. git submodule add https://github.com/corrosion-rs/corrosion.git

从那里开始,使用腐蚀(Corrosion)很简单。在你的 CMakeLists.txt 中:

  1. add_subdirectory(path/to/corrosion)

安装

安装将预构建腐蚀(Corrosion)的所有本地工具(仅 CMake 版本低于 3.19 时需要)并将其与腐蚀(Corrosion)的 CMake 文件一起安装到标准位置。在 CMake >= 3.19 上安装腐蚀(Corrosion)不会提供任何速度优势,除非显式启用了本地工具选项。

从源代码安装

首先,下载并安装腐蚀(Corrosion):

  1. git clone https://github.com/corrosion-rs/corrosion.git
  2. # 可选,指定 -DCMAKE_INSTALL_PREFIX=<target-install-path> 来指定一个自定义安装目录
  3. cmake -Scorrosion -Bbuild -DCMAKE_BUILD_TYPE=Release
  4. cmake --build build --config Release
  5. # 下一步可能需要 sudo 或管理员权限,如果你安装到系统位置,默认即是如此。
  6. cmake --install build --config Release

你需要确保安装目录在你的 PATHCMAKE_PREFIX_PATH 环境变量中可用。在 Unix 系统上,默认情况下可能已经是这样,但在 Windows 上,默认安装到 C:\Program Files (x86)\Corrosion,这通常不会在你的 PATHCMAKE_PREFIX_PATH 中。

一旦腐蚀(Corrosion)安装完成,并确保包在你的 PATH 中可用,你就可以像使用任何其他包一样,从你自己的项目中使用它,在你的 CMakeLists.txt 中:

  1. find_package(Corrosion REQUIRED)

包管理器

Homebrew(非官方)

腐蚀(Corrosion)可以通过 Homebrew 获取,并通过以下命令安装:

  1. brew install corrosion

请注意,这个包是由社区维护的。同时请注意,腐蚀(Corrosion)遵循语义化版本控制,次要版本更新(即 0.3 -> 0.4)可能包含破坏性变化,而腐蚀(Corrosion)仍然在 1.0 之前。升级腐蚀(Corrosion)时,请阅读发布说明。