MD_Parola 项目使用教程
1. 项目的目录结构及介绍
MD_Parola 项目的目录结构如下:
MD_Parola/
├── docs/
├── examples/
├── hardware/
├── media/
│ └── photo/
├── src/
├── .gitattributes
├── .gitignore
├── Doxyfile
├── ISSUE_TEMPLATE.md
├── LICENSE
├── PULL_REQUEST_TEMPLATE.md
├── README.md
├── keywords.txt
└── library.properties
目录介绍
- docs/: 包含项目的文档文件。
- examples/: 包含使用 MD_Parola 库的示例代码。
- hardware/: 包含硬件相关的文档和配置文件。
- media/photo/: 包含项目相关的图片资源。
- src/: 包含 MD_Parola 库的源代码。
- .gitattributes: Git 属性配置文件。
- .gitignore: Git 忽略文件配置。
- Doxyfile: Doxygen 配置文件,用于生成代码文档。
- ISSUE_TEMPLATE.md: GitHub 问题模板文件。
- LICENSE: 项目许可证文件,采用 LGPL-2.1 许可证。
- PULL_REQUEST_TEMPLATE.md: GitHub 拉取请求模板文件。
- README.md: 项目主页文件,包含项目的基本介绍和使用说明。
- keywords.txt: Arduino 库管理器的关键词文件。
- library.properties: Arduino 库属性文件。
2. 项目的启动文件介绍
项目的启动文件主要是 src/MD_Parola.h
和 src/MD_Parola.cpp
。
MD_Parola.h
这是 MD_Parola 库的头文件,定义了库的主要类和接口。
MD_Parola.cpp
这是 MD_Parola 库的实现文件,包含了类的具体实现和功能代码。
3. 项目的配置文件介绍
项目的配置文件主要是 library.properties
。
library.properties
这个文件是 Arduino 库的属性文件,包含以下关键信息:
- name: 库的名称,这里是
MD_Parola
。 - version: 库的版本号。
- author: 库的作者,这里是
majicDesigns
。 - maintainer: 库的维护者,这里是
marco_c
。 - sentence: 库的简短描述。
- paragraph: 库的详细描述。
- category: 库的分类,这里是
Display
。 - url: 库的下载地址。
- architectures: 支持的架构,这里是
*
,表示支持所有架构。
这些配置信息帮助 Arduino IDE 正确识别和管理库。