Skip to content

Commit e8b69b3

Browse files
committed
docs: update Chinese READMEs with devcontainer and install instructions
- Reformat and expand the "从源码安装" (Install from source) section with a proper heading in the Simplified Chinese README - Add instructions for using VSCode Devcontainer, including how to add the CodeGPT feature in devcontainer.json, to both the Simplified and Traditional Chinese READMEs Signed-off-by: appleboy <[email protected]>
1 parent 0c8f505 commit e8b69b3

File tree

2 files changed

+25
-3
lines changed

2 files changed

+25
-3
lines changed

README.zh-cn.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,24 @@ $ codegpt version
5555
version: v0.4.3 commit: xxxxxxx
5656
```
5757

58-
从源代码安装:
58+
### 从源码安装
59+
60+
从源码安装:
5961

6062
```sh
6163
go install github.com/appleboy/CodeGPT/cmd/codegpt@latest
6264
```
6365

66+
### 使用 VSCode Devcontainer
67+
68+
在 devcontainer.json 中添加 [feature](https://github.com/kvokka/features/tree/main/src/codegpt)
69+
70+
```json
71+
"features": {
72+
"ghcr.io/kvokka/features/codegpt:1": {}
73+
}
74+
```
75+
6476
## 设置
6577

6678
请先创建你的 OpenAI API Key。可以在 [OpenAI 平台](https://platform.openai.com/account/api-keys) 生成新的 API Key。
@@ -92,7 +104,7 @@ codegpt config set openai.api_key sk-xxxxxxx
92104
| **openai.proxy** | HTTP/HTTPS 客户端代理。 |
93105
| **openai.socks** | SOCKS 客户端代理。 |
94106
| **openai.timeout** | 默认 HTTP 超时时间是 `10s`(十秒)。 |
95-
| **openai.skip_verify** | 默认skip_verify 设置为 `false`,可以将其更改为 `true` 以忽略 SSL 验证。 |
107+
| **openai.skip_verify** | 默认 skip_verify 设置为 `false`,可以将其更改为 `true` 以忽略 SSL 验证。 |
96108
| **openai.max_tokens** | 默认最大 token 数是 `300`。参见参考 [max_tokens](https://platform.openai.com/docs/api-reference/completions/create#completions/create-max_tokens)|
97109
| **openai.temperature** | 默认温度是 `1`。参见参考 [temperature](https://platform.openai.com/docs/api-reference/completions/create#completions/create-temperature)|
98110
| **git.diff_unified** | 生成具有 `<n>` 行上下文的差异,默认是 `3`|

README.zh-tw.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,16 @@ version: v0.4.3 commit: xxxxxxx
6969
go install github.com/appleboy/CodeGPT/cmd/codegpt@latest
7070
```
7171

72+
### 使用 VSCode Devcontainer
73+
74+
在 devcontainer.json 中添加 [feature](https://github.com/kvokka/features/tree/main/src/codegpt)
75+
76+
```json
77+
"features": {
78+
"ghcr.io/kvokka/features/codegpt:1": {}
79+
}
80+
```
81+
7282
## 設置
7383

7484
首先,創建您的 OpenAI API Key。 [OpenAI 平台](https://platform.openai.com/account/api-keys) 允許您生成新的 API Key。
@@ -98,7 +108,7 @@ codegpt config set openai.api_key sk-xxxxxxx
98108
| **openai.proxy** | HTTP/HTTPS 客戶端代理。 |
99109
| **openai.socks** | SOCKS 客戶端代理。 |
100110
| **openai.timeout** | 默認 HTTP 超時為 `10s`(十秒)。 |
101-
| **openai.skip_verify** | 默認 skip_verify 是 `false` 你可以改為 `true` 以忽略SSL驗證。 |
111+
| **openai.skip_verify** | 默認 skip_verify 是 `false` 你可以改為 `true` 以忽略 SSL 驗證。 |
102112
| **openai.max_tokens** | 默認最大 token 為 `300`。請參閱參考 [max_tokens](https://platform.openai.com/docs/api-reference/completions/create#completions/create-max_tokens)|
103113
| **openai.temperature** | 默認溫度為 `1`。請參閱參考 [temperature](https://platform.openai.com/docs/api-reference/completions/create#completions/create-temperature)|
104114
| **git.diff_unified** | 生成具有 `<n>` 行上下文的差異,默認為 `3`|

0 commit comments

Comments
 (0)