ELuaProfiler 项目启动与配置教程

1. 项目目录结构及介绍

ELuaProfiler 项目目录结构如下：

ELuaProfiler/
├── bin/                         # 存放编译后的可执行文件和运行时需要的资源文件
├── doc/                         # 存放项目文档
├── include/                     # 存放项目的头文件
├── lua/                         # 存放 Lua 相关的库文件和脚本
├── src/                         # 存放项目的源代码文件
├── test/                        # 存放测试代码和测试数据
├── .gitignore                   # 指定 Git 忽略的文件和目录
├── CMakeLists.txt               # CMake 构建脚本
├── README.md                    # 项目说明文件
└── run.sh                       # 项目运行脚本

• bin/：存放编译后的可执行文件和运行时需要的资源文件。
• doc/：存放项目文档，包括用户手册、API 文档等。
• include/：存放项目的头文件，供源代码文件引用。
• lua/：存放 Lua 相关的库文件和脚本，用于项目的 Lua 支持。
• src/：存放项目的源代码文件，包括 C/C++ 文件等。
• test/：存放测试代码和测试数据，用于项目的单元测试和集成测试。
• .gitignore：指定 Git 忽略的文件和目录，以避免将不必要的文件提交到版本控制系统中。
• CMakeLists.txt：CMake 构建脚本，用于构建项目。
• README.md：项目说明文件，介绍项目的基本信息和使用方法。
• run.sh：项目运行脚本，用于一键运行项目。

2. 项目的启动文件介绍

项目的启动文件为 run.sh 脚本，位于项目根目录下。该脚本的作用是简化项目启动流程，一键运行 ELuaProfiler。以下是 run.sh 脚本的内容：

#!/bin/bash

# 判断是否在 Linux 系统下运行
if [[ "$OSTYPE" == "linux-gnu"* ]]; then
    # 运行编译后的可执行文件
    ./bin/ELuaProfiler
else
    echo "Error: This script only supports Linux."
    exit 1
fi

运行 run.sh 脚本前，需要确保已经成功编译了项目，并且可执行文件位于 bin/ 目录下。

3. 项目的配置文件介绍

项目的配置文件为 CMakeLists.txt，用于配置项目的构建过程。以下是一个简化的 CMakeLists.txt 示例：

cmake_minimum_required(VERSION 3.10)

# 设置项目名称和版本
project(ELuaProfiler VERSION 1.0)

# 设置 C++ 标准版本
set(CMAKE_CXX_STANDARD 11)

# 添加子目录
add_subdirectory(src)

# 设置可执行文件的输出目录
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)

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

# 链接 Lua 库
target_link_libraries(ELuaProfiler lua)

该配置文件定义了以下内容：

• 设置项目的最小 CMake 版本要求。
• 设置项目的名称和版本。
• 设置 C++ 标准版本为 C++11。
• 添加 src 目录作为子目录，以便 CMake 能够找到源代码文件。
• 设置可执行文件的输出目录为 bin/。
• 添加 ELuaProfiler 可执行文件，指定主源代码文件 main.cpp。
• 将 Lua 库链接到 ELuaProfiler 可执行文件。

确保在构建项目前，已经正确配置了 CMakeLists.txt 文件，以满足项目的构建需求。