Skip to content

Commit c07aa8d

Browse files
committed
docs: unify and clarify README documentation across all languages
- Improve clarity of instructions about customizing git diff context lines and file exclusion across all language README files - Rename setup section to configuration in all language versions - Change example section title to be more descriptive in the English README Signed-off-by: appleboy <[email protected]>
1 parent ca63223 commit c07aa8d

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ A CLI tool written in [Go](https://go.dev) that generates git commit messages or
2323
- Supports [Azure OpenAI Service](https://azure.microsoft.com/en-us/products/cognitive-services/openai-service), [OpenAI API](https://platform.openai.com/docs/api-reference), [Gemini][60], [Anthropic][100], [Ollama][41], [Groq][30], and [OpenRouter][50].
2424
- Adheres to the [conventional commits specification](https://www.conventionalcommits.org/en/v1.0.0/).
2525
- Integrates with Git prepare-commit-msg Hook, see the [Git Hooks documentation](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks).
26-
- Allows customization of generated diffs with a specified number of context lines (default is three).
27-
- Enables exclusion of files from the git diff command.
26+
- Allows customization of generated diffs by specifying the number of context lines (default: 3).
27+
- Enables file exclusion patterns for git diff operations.
2828
- Translates commit messages into other languages (supports `en`, `zh-tw`, or `zh-cn`).
2929
- Supports SOCKS proxy or custom network HTTP proxy.
3030
- Provides a [model list](https://github.com/appleboy/CodeGPT/blob/bf28f000463cfc6dfa2572df61e1b160c5c680f7/openai/openai.go#L18-L38) including `gpt-4`, `gpt-4o`, etc.
@@ -80,7 +80,7 @@ your devcontainer.json:
8080
}
8181
```
8282

83-
## Setup
83+
## Configuration
8484

8585
First, create your OpenAI API Key. The [OpenAI Platform](https://platform.openai.com/account/api-keys) allows you to generate a new API Key.
8686

@@ -473,7 +473,7 @@ PromptTokens: 287, CompletionTokens: 199, TotalTokens: 486
473473
==================================================
474474
```
475475
476-
another php example code:
476+
Example php code review:
477477
478478
```php
479479
<?php

README.zh-cn.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@
2323
- 支持 [Azure OpenAI Service](https://azure.microsoft.com/en-us/products/cognitive-services/openai-service)[OpenAI API](https://platform.openai.com/docs/api-reference)[Gemini][60][Anthropic][100][Ollama][41][Groq][30][OpenRouter][50]
2424
- 支持 [conventional commits 规范](https://www.conventionalcommits.org/en/v1.0.0/)
2525
- 支持 Git prepare-commit-msg Hook,参见 [Git Hooks 文档](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks)
26-
- 支持自定义生成的差异上下文行数,默认是三行
27-
- 支持从 git diff 命令中排除文件
26+
- 支持通过指定上下文行数自定义差异生成(默认值:3)
27+
- 支持 git diff 排除文件模式
2828
- 支持将提交信息翻译成其他语言(支持 `en``zh-tw``zh-cn`)。
2929
- 支持 socks 代理或自定义网络 HTTP 代理。
3030
- 支持 [模型列表](https://github.com/appleboy/CodeGPT/blob/bf28f000463cfc6dfa2572df61e1b160c5c680f7/openai/openai.go#L18-L38),如 `gpt-4``gpt-4o` 等。
@@ -73,7 +73,7 @@ go install github.com/appleboy/CodeGPT/cmd/codegpt@latest
7373
}
7474
```
7575

76-
## 设置
76+
## 配置
7777

7878
请先创建你的 OpenAI API Key。可以在 [OpenAI 平台](https://platform.openai.com/account/api-keys) 生成新的 API Key。
7979

README.zh-tw.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@
2323
- 支援 [Azure OpenAI Service](https://azure.microsoft.com/en-us/products/cognitive-services/openai-service)[OpenAI API](https://platform.openai.com/docs/api-reference)[Gemini][60][Anthropic][100][Ollama][41][Groq][30][OpenRouter][50]
2424
- 遵循 [conventional commits 規範](https://www.conventionalcommits.org/en/v1.0.0/)
2525
- 與 Git prepare-commit-msg Hook 集成,請參閱 [Git Hooks 文檔](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks)
26-
- 允許自定義生成的差異,指定上下文行數(默認為三行)。
27-
- 允許從 git diff 命令中排除文件
26+
- 允許透過指定上下文行數來自定義差異生成(預設值:3)。
27+
- 支援 git diff 排除檔案模式
2828
- 將提交訊息翻譯成其他語言(支援 `en``zh-tw``zh-cn`)。
2929
- 支援 SOCKS 代理或自定義網絡 HTTP 代理。
3030
- 提供 [模型列表](https://github.com/appleboy/CodeGPT/blob/bf28f000463cfc6dfa2572df61e1b160c5c680f7/openai/openai.go#L18-L38),包括 `gpt-4``gpt-4o` 等。
@@ -79,7 +79,7 @@ go install github.com/appleboy/CodeGPT/cmd/codegpt@latest
7979
}
8080
```
8181

82-
## 設置
82+
## 配置
8383

8484
首先,創建您的 OpenAI API Key。 [OpenAI 平台](https://platform.openai.com/account/api-keys) 允許您生成新的 API Key。
8585

0 commit comments

Comments
 (0)