Glyphs 项目使用教程

Glyphs 项目使用教程

1. 项目的目录结构及介绍

glyphs/
├── docs/
│   └── ...
├── figma-plugin/
│   └── ...
├── lib/
│   └── ...
├── packages/
│   └── ...
├── .gitattributes
├── contributing.md
├── glyphs.fig
├── LICENSE
└── README.md

目录结构介绍

• docs/: 包含项目的文档文件，通常用于存放项目相关的说明文档。
• figma-plugin/: 存放与 Figma 插件相关的代码和资源。
• lib/: 存放项目的核心库文件，通常包含项目的核心逻辑和功能实现。
• packages/: 存放项目的包文件，可能包含项目打包后的输出文件。
• .gitattributes: Git 属性文件，用于定义 Git 如何处理特定文件。
• contributing.md: 贡献指南文件，指导开发者如何为项目做出贡献。
• glyphs.fig: 项目的主要文件，可能是 Figma 设计文件。
• LICENSE: 项目的许可证文件，定义项目的开源许可协议。
• README.md: 项目的自述文件，通常包含项目的简介、安装和使用说明。

2. 项目的启动文件介绍

在 glyphs 项目中，启动文件通常是 README.md 文件。这个文件包含了项目的简介、安装和使用说明，是开发者了解和启动项目的重要入口。

启动文件内容

• 项目简介: 介绍项目的用途和目标。
• 安装说明: 指导开发者如何安装和配置项目。
• 使用说明: 提供项目的基本使用方法和示例。

3. 项目的配置文件介绍

在 glyphs 项目中，配置文件主要包括 .gitattributes 和 contributing.md 文件。

.gitattributes

.gitattributes 文件用于定义 Git 如何处理特定文件。例如，它可以指定某些文件使用特定的换行符格式，或者指定某些文件在 Git 中不被忽略。

contributing.md

contributing.md 文件是项目的贡献指南，指导开发者如何为项目做出贡献。它通常包含以下内容：

• 代码风格: 指导开发者遵循的代码风格和规范。
• 提交指南: 指导开发者如何提交代码和创建 Pull Request。
• 问题报告: 指导开发者如何报告问题和提出改进建议。

通过以上介绍，开发者可以更好地理解和使用 glyphs 项目。