GitHub Spray 项目使用教程

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

GitHub Spray 项目的目录结构如下：

github-spray/
├── patterns/
│   └── space-invaders.json
├── README.md
├── LICENSE
├── github-spray.py
└── requirements.txt

• patterns/: 包含预定义的图案文件，如 space-invaders.json。
• README.md: 项目说明文档。
• LICENSE: 项目许可证文件，采用 MIT 许可证。
• github-spray.py: 项目的主程序文件。
• requirements.txt: 项目依赖的 Python 包列表。

2. 项目的启动文件介绍

项目的启动文件是 github-spray.py。该文件包含了主要的逻辑和功能，用于在 GitHub 贡献图上绘制图案。

3. 项目的配置文件介绍

GitHub Spray 项目的主要配置通过命令行参数进行。以下是一些常用的配置选项：

• --startdate YYYY-MM-DD: 设置图案绘制的起始日期，日期会自动调整为最近的周日。
• -m <factor>: 设置颜色深浅的倍数，通过调整每日提交次数来实现。

例如，使用以下命令可以绘制图案并设置起始日期和颜色倍数：

python github-spray.py -f patterns/space-invaders.json --startdate 2023-01-01 -m 2

以上命令将从 2023 年 1 月 1 日开始绘制 space-invaders 图案，并将颜色倍数设置为 2。

---

通过以上教程，您可以了解 GitHub Spray 项目的目录结构、启动文件和配置方法，从而更好地使用该项目在 GitHub 贡献图上绘制个性化图案。