CommitArt 项目使用教程

CommitArt 项目使用教程

commitartModifying the commit history of git repositories in order to write messages in GitHub's contribution graph.项目地址:https://gitcode.com/gh_mirrors/co/commitart

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

CommitArt 项目的目录结构如下：

commitart/
├── LICENSE
├── README.md
├── alphabet.rb
├── alphabet.yml
├── commitart.rb
└── draw.sh

• LICENSE：项目许可证文件，采用 GPL-2.0 许可证。
• README.md：项目说明文档，包含项目的基本介绍和使用方法。
• alphabet.rb：用于生成字母图案的 Ruby 脚本。
• alphabet.yml：包含字母图案配置的 YAML 文件。
• commitart.rb：主脚本文件，用于生成 GitHub 贡献图上的艺术图案。
• draw.sh：用于绘制特定日期的贡献图的 Shell 脚本。

2、项目的启动文件介绍

项目的启动文件是 commitart.rb。该文件是主脚本文件，负责生成 GitHub 贡献图上的艺术图案。使用方法如下：

ruby commitart.rb

该脚本会根据 alphabet.yml 中的配置生成相应的字母图案，并将其提交到 GitHub 贡献图中。

3、项目的配置文件介绍

项目的配置文件是 alphabet.yml。该文件包含了生成字母图案所需的配置信息。以下是一个示例配置：

A:
  - "0110"
  - "1001"
  - "1111"
  - "1001"
  - "1001"

每个字母对应一个二维数组，数组中的每个元素表示一行，1 表示需要提交的日期，0 表示不需要提交的日期。通过修改该配置文件，可以生成不同的字母图案。

以上是 CommitArt 项目的基本使用教程，希望对您有所帮助。

commitartModifying the commit history of git repositories in order to write messages in GitHub's contribution graph.项目地址:https://gitcode.com/gh_mirrors/co/commitart