Yue 项目使用教程

1. 项目目录结构及介绍

Yue 项目的目录结构如下：

yue/
├── docs/
├── lua/
│   └── lua_yue/
├── napi_yue/
├── nativeui/
├── sample_app/
├── scripts/
├── third_party/
├── .gitattributes
├── .gitignore
├── .gitmodules
├── gn
├── BUILD.gn
├── LICENSE
├── LICENSE.chromium
├── README.md

目录介绍

• docs/: 包含项目的文档文件。
• lua/: 包含 Lua 相关的代码和库。
  • lua_yue/: 具体的 Lua 实现代码。
• napi_yue/: 包含 Node.js 的 N-API 实现代码。
• nativeui/: 包含原生 UI 相关的代码。
• sample_app/: 包含示例应用程序的代码。
• scripts/: 包含项目的脚本文件。
• third_party/: 包含第三方依赖库。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件配置。
• .gitmodules: Git 子模块配置文件。
• gn: GN 构建工具的配置文件。
• BUILD.gn: GN 构建文件。
• LICENSE: 项目的主许可证文件。
• LICENSE.chromium: Chromium 项目的许可证文件。
• README.md: 项目的介绍和使用说明。

2. 项目启动文件介绍

Yue 项目的启动文件通常位于 sample_app/ 目录下。具体启动文件可能因示例应用程序的不同而有所不同。以下是一个典型的启动文件路径：

sample_app/
└── main.cpp

启动文件介绍

• main.cpp: 这是示例应用程序的主启动文件，包含了应用程序的入口函数 main()。该文件负责初始化应用程序并启动主循环。

3. 项目配置文件介绍

Yue 项目的配置文件主要包括以下几个部分：

3.1 GN 构建配置

• gn: GN 构建工具的配置文件，定义了项目的构建规则和依赖关系。
• BUILD.gn: GN 构建文件，包含了项目的构建目标和依赖项。

3.2 Git 配置

• .gitattributes: 定义了 Git 在处理特定文件时的行为。
• .gitignore: 定义了 Git 忽略的文件和目录。
• .gitmodules: 定义了 Git 子模块的配置。

3.3 许可证配置

• LICENSE: 项目的主许可证文件，通常是 LGPL v2.1。
• LICENSE.chromium: Chromium 项目的许可证文件。

3.4 其他配置

• README.md: 项目的介绍和使用说明，通常包含项目的安装和使用步骤。

通过以上配置文件，可以对 Yue 项目进行构建、管理和分发。