Skip to content

Commit 111940a

Browse files
authored
feat: add github login and auto push function
1 parent a01ff8d commit 111940a

23 files changed

+1961
-525
lines changed

README.md

Lines changed: 14 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,22 @@
44
55
## How to use
66

7-
Make sure git is installed on your computer.
7+
Make sure Git is installed on your computer.
88

9-
![app screenshot](/docs/images/appnew_en.png)
9+
![app screenshot](/docs/images/app.png)
1010

11-
Download the application, open it, and let your creativity flow! Generating a repository may take a while. After generation, copy the repository folder and enter it to continue.
11+
Download the app, open it, and first grab a Personal Access Token (PAT) so you can sign in to GitHub. You can follow this guide: [how to get your PAT](docs/githubtoken_en.md).
12+
13+
Once you’re logged in you’ll see your avatar and name in the upper-left corner. Drag across the calendar to paint your design. When you’re satisfied, click **Create Remote Repo**. You can edit the repo name and description, choose whether it’s public or private, and then press **Generate & Push** to let the app create and push the repository for you automatically.
14+
15+
> **Heads-up:** GitHub may take anywhere from 5 minutes to 2 days to show the contributions on your profile. You can keep the repo private and enable “Include private contributions” in your profile settings so others can’t see the repo content but the contribution streak still counts.
16+
17+
![private setting screenshot](docs/images/privatesetting.png)
18+
19+
### Quick Tips
20+
21+
- Right-click while painting to toggle between the brush and the eraser.
22+
- Use the brush intensity control to switch between different shades of green.
1223

1324
### Windows/Linux
1425

@@ -28,25 +39,6 @@ sudo xattr -r -d com.apple.quarantine ./green-wall.app
2839

2940
**Warning:** The commands will not automatically launch the application. You need to manually double-click the app to start it (the commands only modify file attributes).
3041

31-
### Quick Tips
32-
33-
- Right-clicking during the painting process can switch between the brush and the eraser.
34-
35-
## Next steps
36-
37-
1. Log in to your GitHub account and create an empty remote repository (do not select README, .gitignore or License).
38-
2. From the generated repository directory run the following commands to push your local repo to the remote:
39-
40-
```bash
41-
git remote add origin <remote-repo-url>
42-
git branch -M main
43-
git push -u origin main
44-
```
45-
46-
Note: After pushing, GitHub may take anywhere from 5 minutes to two days to show the contribution on your profile. You can make the repository private and enable contributions from private repositories in your GitHub contribution settings so others can't see the repo contents but your contribution activity will still be counted.
47-
48-
![private setting screenshot](docs/images/privatesetting.png)
49-
5042
## Rendering
5143

5244
![text](docs/images/cailg.png)

README_zh.md

Lines changed: 13 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,23 @@
66

77
请确保你的电脑已经安装了 git。
88

9-
![app screenshot](/docs/images/appnew.png)
9+
![app screenshot](/docs/images/app_zh.png)
1010

11-
下载软件,打开,发挥你的艺术才能!生成仓库需要等待一会,生成后复制仓库目录进入仓库文件夹。
11+
下载软件,打开后,首先要获取你的PAT来登录github,你可以参考这个:[如何获取你的github访问令牌](docs/githubtoken.md)
12+
13+
登录成功左上角会显示你的头像和名字。拖动鼠标在日历上尽情画画,发挥你的艺术才能!画完后点击创建远程仓库,你可以自定义仓库名称和描述,选择仓库是否公开,确认无误后点击生成并且推送,软件会自动在你的GitHub上创建对应的仓库。
14+
15+
注意: GitHub 可能需要 5 分钟至两天才会显示你的贡献度图案。你可以把仓库设置为私人仓库,并在贡献统计中允许显示私人仓库的贡献,这样他人看不到仓库内容但可以看到贡献记录。
16+
![private setting screenshot](docs/images/privatesetting.png)
17+
18+
### 快速提示
19+
20+
- 绘画过程中右键可以切换画笔和橡皮擦
21+
- 可以调节画笔的强度
1222

1323
### Windows/Linux
1424

15-
下载后直接点击运行即可。
25+
下载后直接点击运行即可。软件开源,报毒正常
1626

1727
### macOS
1828

@@ -28,25 +38,6 @@ sudo xattr -r -d com.apple.quarantine ./green-wall.app
2838

2939
**警告:** 命令执行后不会自动弹出应用界面,需要手动双击应用来启动(命令只是改变了文件属性)。
3040

31-
### 快速提示
32-
33-
- 绘画过程中右键可以切换画笔和橡皮擦
34-
35-
## 下一步操作
36-
37-
1. 登录你的 GitHub 账号,创建一个空的远程仓库(不要勾选 README、.gitignore 或 License)。
38-
2. 在当前目录执行以下命令,把本地仓库推送到远程仓库:
39-
40-
```bash
41-
git remote add origin <远程仓库地址>
42-
git branch -M main
43-
git push -u origin main
44-
```
45-
46-
注意:推送后 GitHub 可能需要 5 分钟至两天才会显示你的贡献度。你可以把仓库设置为私人仓库,并在贡献统计中允许显示私人仓库的贡献,这样他人看不到仓库内容但可以看到贡献记录。
47-
48-
![private setting screenshot](docs/images/privatesetting.png)
49-
5041
## 效果图
5142

5243
![text](docs/images/cailg.png)

0 commit comments

Comments
 (0)