AX-LLM 项目使用教程

1. 项目目录结构及介绍

AX-LLM 项目的主要目录结构如下：

ax-llm/
├── .gitignore
├── .gitmodules
├── CMakeLists.txt
├── LICENSE
├── README.md
├── build.sh
├── scripts/
├── src/
├── third_party/
├── toolchains/
├── tools/
├── qtproj/
│   ├── LLM-Chat
├──.github/
│   └── workflows/

• .gitignore：Git 忽略文件列表，用于指定在 Git 仓库中应当忽略的文件和目录。
• .gitmodules：用于记录子模块的信息。
• CMakeLists.txt：CMake 的配置文件，用于构建项目。
• LICENSE：项目的许可协议文件，本项目采用 BSD-3-Clause 许可。
• README.md：项目的说明文件，包含了项目的概述、使用说明和联系方式等信息。
• build.sh：项目的编译脚本，用于简化编译过程。
• scripts/：脚本目录，包含了项目构建和运行过程中所需的脚本文件。
• src/：源代码目录，包含了项目的核心源代码文件。
• third_party/：第三方库目录，用于存放项目依赖的外部库。
• toolchains/：工具链目录，包含了项目构建所需的工具链配置。
• tools/：工具目录，包含了项目开发过程中可能用到的工具。
• qtproj/：Qt 项目目录，包含了基于 Qt 框架的 LLM-Chat 项目。
• .github/workflows/：GitHub Actions 工作流目录，用于自动化项目的构建和测试等流程。

2. 项目的启动文件介绍

项目的启动文件是 build.sh，该脚本用于自动化编译过程。以下是启动文件的简要介绍：

# 进入项目目录
cd ax-llm

# 递归克隆子模块
git clone --recursive https://github.com/AXERA-TECH/ax-llm.git

# 修改 build.sh 中的 BSP_MSP_DIR 变量以指向正确的板级支持包目录

# 运行编译脚本
./build.sh

在运行 build.sh 脚本之前，确保已经正确配置了环境变量和依赖项。编译完成后，在 build/install/bin 目录下会生成可执行文件。

3. 项目的配置文件介绍

项目的配置文件是 CMakeLists.txt，该文件用于配置 CMake 构建系统。以下是配置文件的关键部分介绍：

cmake_minimum_required(VERSION 3.10)

# 设置项目名称和版本
project(AX-LLM VERSION 1.0)

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

# 配置编译选项
set(CMAKE_BUILD_TYPE Release)

# 查找并包含所需的库
find_package(所需的库 REQUIRED)

# 添加子目录
add_subdirectory(src)

# 指定可执行文件输出目录
set(CMAKE_EXECUTABLE_PATH ${CMAKE_SOURCE_DIR}/build/install/bin)

# 定义源文件和目标链接库
add_executable(AX-LLM src/main.cpp)
target_link_libraries(AX-LLM REQUIRED 库列表)

在 CMakeLists.txt 文件中，需要根据项目实际情况配置编译选项、查找依赖库和指定源文件等。确保所有依赖项都已正确安装，并且路径设置正确。

通过以上介绍，用户可以开始对 AX-LLM 项目进行编译和运行。在遇到问题时，可以参考项目的 GitHub 仓库中的 README.md 文件或者通过 GitHub issues 或 QQ 群等渠道寻求帮助。