Unity-Technologies/crunch 项目启动与配置教程

1. 项目目录结构及介绍

crunch 项目目录结构如下：

crunch/
├── bin/                       # 存放编译后的可执行文件
├── crnlib/                    # crnlib 源代码，包含核心的压缩算法
├── crunch/                    # crunch 工具的源代码
├── emscripten/                # Emscripten 相关文件
├── example1/                  # 示例项目 1
├── example2/                  # 示例项目 2
├── example3/                  # 示例项目 3
├── inc/                       # 包含头文件和单文件库
├── .gitignore                 # 指定 Git 忽略的文件和目录
├── CHANGELOG.md               # 项目更新日志
├── README.md                  # 项目说明文件
├── crn.2008.sln               # Visual Studio 2008 解决方案文件
├── crn.workspace              # Visual Studio 工作区文件
├── crn_examples.2008.sln      # 示例项目的 Visual Studio 2008 解决方案文件
├── crn_linux.workspace        # Linux 平台的构建文件
├── license.txt                # 项目使用的许可证文件

• bin/：包含项目的编译输出，如可执行文件和库文件。
• crnlib/：包含了核心的压缩库 crnlib 的源代码。
• crunch/：包含了 crunch 工具的源代码，用于压缩纹理。
• emscripten/：包含了用于将 crunch 编译为 WebAssembly 的 Emscripten 相关文件。
• example1/、example2/、example3/：提供了使用 crunch 的示例项目。
• inc/：包含了头文件和单文件库，这些是编译项目必需的。
• .gitignore：指定了在 Git 版本控制中应该忽略的文件和目录。
• CHANGELOG.md：记录了项目的更新历史和版本变化。
• README.md：提供了关于项目的详细描述、使用说明和联系方式。
• crn.2008.sln、crn.workspace、crn_examples.2008.sln、crn_linux.workspace：分别是用于不同开发环境的解决方案和工作区文件。
• license.txt：包含了项目的许可证信息。

2. 项目的启动文件介绍

项目的启动主要是通过编译 crunch 工具。crunch 工具的源代码位于 crunch/ 目录下。编译完成后，生成的可执行文件将放在 bin/ 目录中。

要编译 crunch，可以使用以下命令（假设已经安装了相应的编译器和依赖）：

mkdir build
cd build
cmake ..
make

编译完成后，可以在 bin/ 目录中找到 crunch 可执行文件。

3. 项目的配置文件介绍

crunch 项目的主要配置文件是 CMakeLists.txt，它位于项目的根目录。这个文件用于配置 CMake 构建系统，以便能够正确地编译项目。

以下是 CMakeLists.txt 文件的一些基本配置：

cmake_minimum_required(VERSION 3.10)
project(crunch)

# 设置编译器选项
set(CMAKE_CXX_STANDARD 11)
set(CMAKE_CXX_STANDARD_REQUIRED True)

# 查找项目依赖
find_package(XXX REQUIRED)

# 添加库和可执行文件
add_library(crnlib ...)
add_executable(crunch ...)
target_link_libraries(crunch crnlib ...)

# 设置包含目录
target_include_directories(crnlib PUBLIC ...)
target_include_directories(crunch PRIVATE ...)

在这个文件中，你可以配置编译选项、项目依赖、库和可执行文件的编译目标，以及包含目录。

另外，项目的 license.txt 文件包含了项目使用的许可证信息，这是在配置项目时必须遵守的。

正确配置和编译 crunch 后，就可以使用它来压缩纹理，并通过示例项目来了解如何集成和使用 crnlib。