Skip to content

Commit 2ff27c3

Browse files
DoragdDoragd
committed
add usage
1 parent 7940d77 commit 2ff27c3

6 files changed

Lines changed: 73 additions & 391 deletions

File tree

‎.github/workflows/update_readme.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: update_DailyLC
1+
name: update_readme
22

33
on:
44
workflow_dispatch:
@@ -30,12 +30,12 @@ jobs:
3030
python -m pip install --upgrade pip
3131
pip install requests PyGithub
3232
33-
- name: Get issue data and update DailyLC.md
33+
- name: Get issue data and update README.md
3434
run: python main.py --issue_number '${{ github.event.issue.number }}'
3535
env:
3636
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
3737

38-
- name: Push DailyLC
38+
- name: Push readme
3939
run: |
4040
git config --local user.email "[email protected]"
4141
git config --local user.name "GitHub Action"

‎DailyLC.md‎

Lines changed: 0 additions & 25 deletions
This file was deleted.

‎README.md‎

Lines changed: 19 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,29 @@
1-
# 🎯 Usage
1+
# 📝 Algorithm
2+
算法题练习记录博客，基于GitHub Action和GitHub Issue功能记录
23

3-
算法题练习记录博客（基于GitHub Action和GitHub Issue实现）。
4+
## 🎄 How to Use
45

5-
可通过提交issue，自动将刷题记录更新在项目的README.md中，并将issue内容备份在项目backup文件夹下。
6+
❗ 请注意，不要在本项目下提交刷题记录，正确方法如下：
67

7-
## Step 1: fork该项目
8+
查看[Usage](Usage.md)文档，创建并使用一个个人专属的记录博客。
89

9-
激活GitHub Actions功能
10-
<img width="1417" alt="image" src="https://github.com/Doragd/Algorithm/assets/26213546/1817745f-5552-41fe-84fc-1137c8882b34">
1110

12-
打开fork项目的issues功能
13-
* 点击下图所示按钮
14-
<img width="1033" alt="image" src="https://github.com/Doragd/Algorithm/assets/26213546/b3800afe-98c1-4358-8c3c-03d48b442be1">
15-
* 进入到setting页面，在这一页往下翻
16-
<img width="1328" alt="image" src="https://github.com/Doragd/Algorithm/assets/26213546/eab6f005-0165-4b46-a4b3-e3379cb71351">
17-
* 找到Features一节，然后勾选Issues
18-
<img width="1275" alt="image" src="https://github.com/Doragd/Algorithm/assets/26213546/12e2f7c6-064d-46b0-b47b-a7a80018935a">
11+
## 🎯 Calendar
1912

13+
* 2023/12
2014

21-
## Step 2: 提交issue
15+
|Mon|Tue|Wed|Thu|Fri|Sat|Sun|
16+
|:-:|:-:|:-:|:-:|:-:|:-:|:-:|
17+
|27|28|29|30|1|2|3|
18+
|4|5|6|7|8|9|10🌟|
19+
|11|12|13|14|15|16|17|
20+
|18|19|20|21|22|23|24|
21+
|25|26|27|28|29|30|31|
2222

23-
每当你刷完一道算法题，可在你的项目上提交一个issue：
24-
* issue title可以是所刷题目的标题，也可以是其他任意你想记录的笔记标题。
25-
* 同时，你也可以为这个issue打上label，例如二叉树、搜索。
26-
* 将你想记录的对这道题的思考作为issue的description。
27-
[示例issue](https://github.com/Doragd/Algorithm/issues/3)
2823

29-
<img width="1239" alt="image" src="https://github.com/Doragd/Algorithm/assets/26213546/9d6cabf6-9af1-487e-bcde-3c459a3c0892">
30-
31-
## Step 3: 查看效果
32-
33-
此时[README.md](README.md) 中
34-
35-
1） Calendar部分会基于issue创建日期在日历上标记一个star
36-
37-
2） Records部分会新增一行记录, 各列分别记录：
38-
39-
#: issue号
40-
Title: issue title（点击可跳转至你所创建的issue）
41-
Tag： issue Labels
42-
Date: issue创建时间
43-
44-
同时，backup文件夹下会以“issue号+#+的issue title"作为文件名，生成一个对issue的备份文件，备份issue的description。该issue下所有后续的comments也会被记录下来。[示例备份文件](backup/2#110.%20平衡二叉树.md)
45-
46-
## Step 4: 编辑和更新
47-
48-
当你编辑issue的title或description、修改issue的Labels、issue有新comment或者issue的comment被编辑时, [README.md](README.md)和backup文件夹下issue的备份文件都会进行相应更新
24+
## 🍃 Records
4925

26+
|#|Title|Tag|Date|
27+
|:-:|:-:|:-:|:-:|
28+
|3|[100. 相同的树](https://github.com/Doragd/Algorithm/issues/3)|`二叉树` `递归`|2023-12-10T12:14:09Z|
29+
|2|[110. 平衡二叉树](https://github.com/Doragd/Algorithm/issues/2)|`二叉树` `递归`|2023-12-10T10:56:53Z|

‎Usage.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# 🎯 Usage
2+
3+
算法题练习记录博客（基于GitHub Action和GitHub Issue实现）。
4+
5+
可通过提交issue，自动将刷题记录更新在项目的README.md中，并将issue内容备份在项目backup文件夹下。
6+
7+
## Step 1: fork该项目
8+
9+
激活GitHub Actions功能
10+
<img width="1417" alt="image" src="https://github.com/Doragd/Algorithm/assets/26213546/1817745f-5552-41fe-84fc-1137c8882b34">
11+
12+
打开fork项目的issues功能
13+
* 点击下图所示按钮
14+
<img width="1033" alt="image" src="https://github.com/Doragd/Algorithm/assets/26213546/b3800afe-98c1-4358-8c3c-03d48b442be1">
15+
* 进入到setting页面，在这一页往下翻
16+
<img width="1328" alt="image" src="https://github.com/Doragd/Algorithm/assets/26213546/eab6f005-0165-4b46-a4b3-e3379cb71351">
17+
* 找到Features一节，然后勾选Issues
18+
<img width="1275" alt="image" src="https://github.com/Doragd/Algorithm/assets/26213546/12e2f7c6-064d-46b0-b47b-a7a80018935a">
19+
20+
21+
## Step 2: 提交issue
22+
23+
每当你刷完一道算法题，可在你的项目上提交一个issue：
24+
* issue title可以是所刷题目的标题，也可以是其他任意你想记录的笔记标题。
25+
* 同时，你也可以为这个issue打上label，例如二叉树、搜索。
26+
* 将你想记录的对这道题的思考作为issue的description。
27+
[示例issue](https://github.com/Doragd/Algorithm/issues/3)
28+
29+
<img width="1239" alt="image" src="https://github.com/Doragd/Algorithm/assets/26213546/9d6cabf6-9af1-487e-bcde-3c459a3c0892">
30+
31+
## Step 3: 查看效果
32+
33+
此时[README.md](README.md) 中
34+
35+
1） Calendar部分会基于issue创建日期在日历上标记一个star
36+
37+
2） Records部分会新增一行记录, 各列分别记录：
38+
39+
#: issue号
40+
Title: issue title（点击可跳转至你所创建的issue）
41+
Tag： issue Labels
42+
Date: issue创建时间
43+
44+
同时，backup文件夹下会以“issue号+#+的issue title"作为文件名，生成一个对issue的备份文件，备份issue的description。该issue下所有后续的comments也会被记录下来。[示例备份文件](backup/2#110.%20平衡二叉树.md)
45+
46+
## Step 4: 编辑和更新
47+
48+
当你编辑issue的title或description、修改issue的Labels、issue有新comment或者issue的comment被编辑时, [README.md](README.md)和backup文件夹下issue的备份文件都会进行相应更新
49+

0 commit comments

Comments
 (0)