LunaSDK 项目启动与配置教程

1. 项目目录结构及介绍

LunaSDK 是一个为实时渲染应用程序设计的 C++ 软件开发框架。以下是项目的目录结构及各部分功能的简要介绍：

LunaSDK/
│
├── .github/             # GitHub 工作流程目录
├── Modules/             # 模块目录，包含框架的核心模块
├── Programs/            # 程序目录，可能包含示例程序或工具
├── Tests/               # 测试目录，包含单元测试和集成测试
├── Tools/               # 工具目录，可能包含构建工具和脚本
├── .gitattributes        # Git 属性配置文件
├── .gitignore           # Git 忽略文件
├── LICENSE.txt          # 许可证文件
├── README.md            # 项目说明文件
├── gen_vs2019.bat        # 生成 Visual Studio 2019 工程文件的批处理脚本
├── gen_xcode.sh         # 生成 XCode 工程文件的脚本
├── setup.bat            # 项目设置批处理脚本（Windows）
├── setup.sh             # 项目设置脚本（macOS/Linux）
├── xmake.lua            # XMake 构建配置文件

2. 项目的启动文件介绍

项目的启动文件主要包括设置脚本和构建脚本：

• setup.bat（Windows）：运行此批处理脚本将进行项目的基本设置，例如安装依赖项和配置环境。
• setup.sh（macOS/Linux）：与 setup.bat 类似，此脚本用于在 macOS 或 Linux 系统上设置项目。
• xmake.lua：XMake 是一个跨平台构建工具，此文件定义了项目的构建规则和依赖关系。

要启动项目，你通常需要先运行相应的设置脚本，然后使用 XMake 来构建项目：

# Windows
setup.bat
xmake build

# macOS/Linux
./setup.sh
xmake build

3. 项目的配置文件介绍

项目的配置文件主要包括 Git 忽略文件和 XMake 构建配置文件：

• .gitignore：此文件列出了一些 Git 应该忽略的文件和目录，比如编译生成的临时文件或编辑器的缓存文件。
• xmake.lua：此文件是 XMake 的配置文件，它定义了项目的构建目标和依赖关系，以及如何编译和链接项目。你可以通过修改此文件来配置不同的编译选项，例如目标平台、架构和编译模式。

以下是一个 xmake.lua 的示例配置：

-- 设置项目信息
set_project("LunaSDK")
set_version("1.0.0")

-- 设置目标
target("LunaSDK")
    -- 设置编译类型
    set_kind("static")
    -- 添加源文件
    add_files("Modules/**/*.cpp")
    -- 添加包含目录
    add_includedirs("Modules")
    -- 设置编译器
    set编译器("g++")
    -- 设置编译选项
    set_cflags("-Wall -Wextra -O2")

通过了解这些文件和目录，你可以更好地开始使用 LunaSDK，并根据需要对其进行配置和扩展。