Gitartwork安装与配置指南

Gitartwork安装与配置指南

gitartwork Gitartwork on user's contribution graph 项目地址: https://gitcode.com/gh_mirrors/gi/gitartwork

1. 项目基础介绍

Gitartwork 是一个开源项目，它能够根据用户的GitHub贡献图生成一个SVG图像，并将这个图像推送回用户的GitHub仓库。该项目主要用于个性化展示GitHub用户的贡献情况。

主要的编程语言：JavaScript

2. 项目使用的关键技术和框架

• Node.js：项目的运行环境，用于执行JavaScript代码。
• GitHub Actions：允许用户自动化他们的软件开发工作流程。
• SVG生成：使用JavaScript生成 Scalable Vector Graphics (SVG) 图像。

3. 项目安装和配置的准备工作及详细步骤

准备工作

在开始安装和配置Gitartwork之前，请确保您已经具备以下条件：

• 安装了Git。
• 拥有一个GitHub账户。
• 能够在您的计算机上运行Node.js。

安装步骤

步骤 1：创建新的GitHub仓库

1. 访问 GitHub 并登录到您的账户。
2. 点击右上角的“+”号，选择“New repository”。
3. 输入仓库名称，例如 gitartwork-demo，然后点击“Create repository”。

步骤 2：设置GitHub Actions权限

1. 在您的GitHub仓库中，点击“Settings”。
2. 滚动到“Actions”部分。
3. 在“Workflow permissions”下，确保“Read and write permissions”被选中。
4. 点击“Save”保存设置。

步骤 3：添加GitHub Action工作流文件

1. 在您的GitHub仓库中，创建一个名为 .github/workflows/gitartwork.yml 的文件。
2. 将以下内容复制并粘贴到该文件中：

name: gitartwork from a contribution graph

on:
  push:

jobs:
  build:
    name: Make gitartwork SVG
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
    - uses: jasineri/gitartwork@v1
      with:
        # 使用这个用户名的贡献图
        user_name: jasineri
        # 贡献图上的文本
        text: '您的GitHub用户名'
    - uses: jasineri/simple-push-action@v1

请将 user_name 和 text 的值替换为您的GitHub用户名和您希望在贡献图上显示的文本。

步骤 4：推送工作流文件到GitHub仓库

1. 打开终端（或命令提示符）。
2. 初始化一个新的Git仓库（如果您还没有）并添加一个远程仓库指向您的GitHub仓库。

git init
git remote add origin https://github.com/您的GitHub用户名/gitartwork-demo.git

3. 将 .github/workflows/gitartwork.yml 文件添加到您的本地仓库。

git add .github/workflows/gitartwork.yml

4. 提交更改。

git commit -m "Add gitartwork GitHub Action"

5. 推送更改到远程仓库。

git push origin main

完成以上步骤后，GitHub Actions将自动运行，并在您的仓库中生成一个 gitartwork.svg 文件。然后，您可以将其添加到 README.md 文件中，通过以下方式显示：

![gitartwork](gitartwork.svg)

按照这个指南，即使是编程新手也应该能够成功安装和配置Gitartwork项目。

gitartwork Gitartwork on user's contribution graph 项目地址: https://gitcode.com/gh_mirrors/gi/gitartwork