Embedded Graphics 项目教程

1. 项目目录结构及介绍

Embedded Graphics 项目的目录结构如下：

embedded-graphics/
├── assets/
├── benches/
├── core/
├── doc/
├── fonts/
├── src/
├── tests/
├── tools/
├── .dockerignore
├── .gitattributes
├── .gitignore
├── CHANGELOG.md
├── Cargo.toml
├── LICENSE-APACHE
├── LICENSE-MIT
├── MIGRATING-0.5-0.6.md
├── MIGRATING-0.6-0.7.md
├── README.md
├── README.tpl
├── RELEASES.md
├── filter-readme.sed
├── justfile
├── release.toml
├── rustfmt.nightly.toml

目录介绍

• assets/: 存放项目相关的资源文件。
• benches/: 存放性能测试代码。
• core/: 存放核心库代码。
• doc/: 存放项目文档。
• fonts/: 存放字体相关的代码和资源。
• src/: 存放项目的源代码。
• tests/: 存放测试代码。
• tools/: 存放项目使用的工具脚本。
• .dockerignore: Docker 忽略文件。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件。
• CHANGELOG.md: 项目更新日志。
• Cargo.toml: Rust 项目的配置文件。
• LICENSE-APACHE: Apache 许可证文件。
• LICENSE-MIT: MIT 许可证文件。
• MIGRATING-0.5-0.6.md: 从 0.5 版本迁移到 0.6 版本的指南。
• MIGRATING-0.6-0.7.md: 从 0.6 版本迁移到 0.7 版本的指南。
• README.md: 项目介绍和使用说明。
• README.tpl: README 模板文件。
• RELEASES.md: 发布说明。
• filter-readme.sed: 用于处理 README 文件的脚本。
• justfile: Justfile 配置文件。
• release.toml: 发布配置文件。
• rustfmt.nightly.toml: Rustfmt 配置文件。

2. 项目的启动文件介绍

Embedded Graphics 项目的启动文件是 src/lib.rs。这个文件是项目的入口点，包含了项目的初始化和核心功能的实现。

src/lib.rs 文件介绍

// src/lib.rs

// 导入必要的模块
mod draw_target;
mod examples;
mod framebuffer;
mod geometry;
mod image;
mod iterator;
mod mock_display;
mod mono_font;
mod pixelcolor;
mod prelude;
mod primitives;
mod text;
mod transform;

// 导出公共模块
pub use draw_target::*;
pub use examples::*;
pub use framebuffer::*;
pub use geometry::*;
pub use image::*;
pub use iterator::*;
pub use mock_display::*;
pub use mono_font::*;
pub use pixelcolor::*;
pub use prelude::*;
pub use primitives::*;
pub use text::*;
pub use transform::*;

// 其他初始化代码

3. 项目的配置文件介绍

Cargo.toml

Cargo.toml 是 Rust 项目的配置文件，包含了项目的依赖、元数据和其他配置信息。

[package]
name = "embedded-graphics"
version = "0.8.1"
authors = ["Your Name <[e-mail]>"]
edition = "2018"

[dependencies]
# 项目依赖的其他库

[features]
# 项目支持的特性

[workspace]
# 工作区配置

rustfmt.nightly.toml

rustfmt.nightly.toml 是 Rustfmt 的配置文件，用于配置代码格式化工具的行为。

# rustfmt.nightly.toml

# 配置 Rustfmt 的选项

justfile

justfile 是 Just 工具的配置文件，用于定义项目的构建和测试命令。

# justfile

# 定义构建命令
build:
    cargo build

# 定义测试命令
test:
    cargo test

通过以上介绍，您可以更好地理解和使用 Embedded Graphics 项目。