GitHub Vanity 项目使用教程

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

GitHub Vanity 项目旨在帮助用户在 GitHub 的活动图表上绘制自定义文本。以下是项目的目录结构及其说明：

• LICENSE：项目的开源许可证文件，说明了项目的版权和使用条款。
• README.rst：项目的详细说明文档，包含了项目的安装和使用方法。
• pyproject.toml：Python 项目配置文件，定义了项目的元数据和依赖。
• setup.cfg：设置文件，用于配置项目的打包和安装参数。
• .gitignore：Git 忽略文件，用于指定在 Git 仓库中应该忽略的文件和目录。
• Makefile：构建文件，可能包含项目的构建和打包指令。
• vanity.jpg：示例图片文件，可能是项目的一个示例输出或图标。
• github_vanity：项目的主要 Python 脚本文件，包含了实现功能的代码。

2. 项目的启动文件介绍

项目的启动文件是 github_vanity，它是项目的核心部分。这个脚本负责以下功能：

• 接受命令行参数，如要写入活动图表的文本、开始日期、偏移量、字符间距等。
• 初始化一个空的 Git 仓库，或者修改现有的仓库。
• 向仓库中添加提交记录，以在活动图表上形成文本。

使用前，你需要确保已经安装了 Python 和 Git，并且可以运行 Python 脚本。

3. 项目的配置文件介绍

项目的主要配置文件是 pyproject.toml。这个文件定义了以下内容：

• [build-system]：指定了构建系统的需求和元数据。
• [tool]：定义了项目使用的工具和插件，例如 setuptools 和 wheel。
• [project]：包含了项目的元数据，如名称、版本、作者、许可证等。

这些配置信息对于打包和分发项目非常重要，它们确保了项目可以在不同的环境中正确安装和使用。

在开始使用本项目之前，请确保已经阅读了 README.rst 文件，以获取更详细的安装和使用说明。