Skip to content

Commit e98d904

Browse files
committed
docs: unify and enhance project README structure and content
- Move language selection links in all three README files below the badges and project description - Add brief one-line project description and useful related resource links near the top of each README - Improve overall consistency of README structure between English, Simplified Chinese, and Traditional Chinese versions Signed-off-by: appleboy <[email protected]>
1 parent 89bb3f0 commit e98d904

File tree

3 files changed

+21
-21
lines changed

3 files changed

+21
-21
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
11
# CodeGPT
22

3-
**English** | [繁體中文](./README.zh-tw.md) | [简体中文](./README.zh-cn.md)
4-
53
[![Lint and Testing](https://github.com/appleboy/CodeGPT/actions/workflows/testing.yml/badge.svg?branch=main)](https://github.com/appleboy/CodeGPT/actions/workflows/testing.yml)
64
[![codecov](https://codecov.io/gh/appleboy/CodeGPT/branch/main/graph/badge.svg)](https://codecov.io/gh/appleboy/CodeGPT)
75
[![Go Report Card](https://goreportcard.com/badge/github.com/appleboy/CodeGPT)](https://goreportcard.com/report/github.com/appleboy/CodeGPT)
86

7+
A CLI tool written in [Go](https://go.dev) that generates git commit messages or provides code review summaries using ChatGPT AI (gpt-4o, gpt-4 model). It also automatically installs a [git prepare-commit-msg hook](https://git-scm.com/docs/githooks).
8+
9+
- [繁體中文介紹][1]
10+
- [繁體中文影片][2]
11+
12+
**English** | [繁體中文](./README.zh-tw.md) | [简体中文](./README.zh-cn.md)
13+
914
![cover](./images/cover.png)
1015

1116
## Table of Contents
@@ -43,11 +48,6 @@
4348
- [Star History](#star-history)
4449
- [Reference](#reference)
4550

46-
A CLI tool written in [Go](https://go.dev) that generates git commit messages or provides code review summaries using ChatGPT AI (gpt-4o, gpt-4 model). It also automatically installs a [git prepare-commit-msg hook](https://git-scm.com/docs/githooks).
47-
48-
- [繁體中文介紹][1]
49-
- [繁體中文影片][2]
50-
5151
[1]: https://blog.wu-boy.com/2023/03/writes-git-commit-messages-using-chatgpt/
5252
[2]: https://www.youtube.com/watch?v=4Yei_t6eMZU
5353

README.zh-cn.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
11
# CodeGPT
22

3-
[English](./README.md) | [繁體中文](./README.zh-tw.md) | **简体中文**
4-
53
[![Lint and Testing](https://github.com/appleboy/CodeGPT/actions/workflows/testing.yml/badge.svg?branch=main)](https://github.com/appleboy/CodeGPT/actions/workflows/testing.yml)
64
[![codecov](https://codecov.io/gh/appleboy/CodeGPT/branch/main/graph/badge.svg)](https://codecov.io/gh/appleboy/CodeGPT)
75
[![Go Report Card](https://goreportcard.com/badge/github.com/appleboy/CodeGPT)](https://goreportcard.com/report/github.com/appleboy/CodeGPT)
86

7+
一个用 [Go](https://go.dev) 编写的 CLI 工具,它使用 ChatGPT AI(gpt-4o,gpt-4 模型)为你编写 git 提交信息或提供代码审查摘要,并自动安装 [git prepare-commit-msg hook](https://git-scm.com/docs/githooks)
8+
9+
- [繁體中文介紹][1]
10+
- [繁體中文影片][2]
11+
12+
[English](./README.md) | [繁體中文](./README.zh-tw.md) | **简体中文**
13+
914
![cover](./images/cover.png)
1015

1116
## 目录
@@ -36,11 +41,6 @@
3641
- [安装 hook](#安装-hook)
3742
- [卸载 hook](#卸载-hook)
3843

39-
一个用 [Go](https://go.dev) 编写的 CLI 工具,它使用 ChatGPT AI(gpt-4o,gpt-4 模型)为你编写 git 提交信息或提供代码审查摘要,并自动安装 [git prepare-commit-msg hook](https://git-scm.com/docs/githooks)
40-
41-
- [繁體中文介紹][1]
42-
- [繁體中文影片][2]
43-
4444
[1]: https://blog.wu-boy.com/2023/03/writes-git-commit-messages-using-chatgpt/
4545
[2]: https://www.youtube.com/watch?v=4Yei_t6eMZU
4646

README.zh-tw.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
11
# CodeGPT
22

3-
[English](./README.md) | **繁體中文** | [简体中文](./README.zh-cn.md)
4-
53
[![Lint and Testing](https://github.com/appleboy/CodeGPT/actions/workflows/testing.yml/badge.svg?branch=main)](https://github.com/appleboy/CodeGPT/actions/workflows/testing.yml)
64
[![codecov](https://codecov.io/gh/appleboy/CodeGPT/branch/main/graph/badge.svg)](https://codecov.io/gh/appleboy/CodeGPT)
75
[![Go Report Card](https://goreportcard.com/badge/github.com/appleboy/CodeGPT)](https://goreportcard.com/report/github.com/appleboy/CodeGPT)
86

7+
一個用 [Go](https://go.dev) 編寫的 CLI 工具,使用 ChatGPT AI (gpt-4o, gpt-4 模型) 生成 git 提交訊息或提供代碼審查摘要。它還會自動安裝 [git prepare-commit-msg hook](https://git-scm.com/docs/githooks)
8+
9+
- [繁體中文介紹][1]
10+
- [繁體中文影片][2]
11+
12+
[English](./README.md) | **繁體中文** | [简体中文](./README.zh-cn.md)
13+
914
![cover](./images/cover.png)
1015

1116
## 目錄
@@ -43,11 +48,6 @@
4348
- [Star History](#star-history)
4449
- [參考資料(Reference)](#參考資料reference)
4550

46-
一個用 [Go](https://go.dev) 編寫的 CLI 工具,使用 ChatGPT AI (gpt-4o, gpt-4 模型) 生成 git 提交訊息或提供代碼審查摘要。它還會自動安裝 [git prepare-commit-msg hook](https://git-scm.com/docs/githooks)
47-
48-
- [繁體中文介紹][1]
49-
- [繁體中文影片][2]
50-
5151
[1]: https://blog.wu-boy.com/2023/03/writes-git-commit-messages-using-chatgpt/
5252
[2]: https://www.youtube.com/watch?v=4Yei_t6eMZU
5353

0 commit comments

Comments
 (0)