Arduboy2 项目使用教程

1. 项目目录结构及介绍

Arduboy2 项目的目录结构如下：

Arduboy2/
├── examples/
│   └── ...
├── extras/
│   └── ...
├── src/
│   └── ...
├── .gitignore
├── CONTRIBUTING.md
├── LICENSE.txt
├── README.md
├── keywords.txt
├── library.json
└── library.properties

目录介绍：

• examples/: 包含示例代码，展示了如何使用 Arduboy2 库。
• extras/: 包含额外的文档和配置文件，如 Doxygen 配置文件。
• src/: 包含 Arduboy2 库的核心源代码。
• .gitignore: Git 忽略文件，指定哪些文件或目录不需要被 Git 管理。
• CONTRIBUTING.md: 贡献指南，指导开发者如何为项目贡献代码。
• LICENSE.txt: 项目许可证文件，说明项目的开源许可协议。
• README.md: 项目说明文件，包含项目的概述、安装方法和使用说明。
• keywords.txt: Arduino IDE 关键字文件，用于高亮显示代码中的关键字。
• library.json: 库的 JSON 描述文件，用于 Arduino IDE 库管理器。
• library.properties: 库的属性文件，包含库的名称、版本等信息。

2. 项目启动文件介绍

Arduboy2 项目的启动文件是 src/Arduboy2.h，它是 Arduboy2 库的主头文件。在使用 Arduboy2 库时，需要在代码的开头包含这个头文件：

#include <Arduboy2.h>

在 setup() 函数中，需要调用 begin() 函数来初始化库：

void setup() {
    arduboy.begin();
    // 其他初始化代码
}

begin() 函数包含了启动时的一些特性，如显示 Arduboy 标志、控制 RGB LED 等。

3. 项目配置文件介绍

3.1 library.properties

library.properties 文件包含了 Arduboy2 库的基本信息，如库的名称、版本、作者等。以下是文件内容的示例：

name=Arduboy2
version=4.1.2
author=MLXXXp
maintainer=MLXXXp
sentence=An alternative library for the Arduboy miniature game system
paragraph=The Arduboy2 library provides a standard API to the display, buttons, and other hardware of the Arduino based Arduboy miniature game system.
category=Device Control
url=https://github.com/MLXXXp/Arduboy2
architectures=*

3.2 keywords.txt

keywords.txt 文件用于定义 Arduino IDE 中的关键字，以便在代码编辑器中高亮显示。以下是文件内容的示例：

Arduboy2	KEYWORD1
begin	KEYWORD2
clear	KEYWORD2
display	KEYWORD2

3.3 extras/Doxyfile

extras/Doxyfile 是 Doxygen 文档生成工具的配置文件，用于生成 Arduboy2 库的 API 文档。生成的 HTML 文件可以在 extras/Doxygen/html/index.html 中找到。

3.4 CONTRIBUTING.md

CONTRIBUTING.md 文件提供了贡献指南，指导开发者如何为 Arduboy2 项目贡献代码。文件内容包括代码风格、提交 PR 的步骤等。

3.5 LICENSE.txt

LICENSE.txt 文件包含了 Arduboy2 项目的开源许可证信息，通常是 MIT 许可证。

通过以上介绍，您可以更好地理解 Arduboy2 项目的结构和配置文件的作用，从而更高效地使用和开发基于 Arduboy2 的项目。