Skip to content

Commit 2f9b561

Browse files
committed
docs: update readme_cn for new running settings.
1 parent c971121 commit 2f9b561

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README_CN.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,13 @@ Enter the request timeout (seconds) [60.0]:
119119
Enter the base URL [https://api.openai.com/v1]:
120120
```
121121

122+
## 运行RepoAgent
123+
124+
进入RepoAgent根目录并在终端尝试以下命令:
125+
```sh
126+
repoagent run # 这条命令会生成文档或自动更新文档 (pre-commit-hook 会自动调用它)
127+
```
128+
122129
run 命令支持以下可选标志(如果设置,将覆盖配置默认值):
123130

124131
- `-m`, `--model` TEXT:指定用于完成的模型。默认值:`gpt-3.5-turbo`
@@ -145,7 +152,7 @@ repoagent diff # 此命令将检查基于当前代码更改将更新/生成哪
145152

146153
当您首次完成对目标仓库生成全局文档后,或您clone下来的项目已经包含了全局文档信息后,就可以通过**pre-commit**配置目标仓库**hook**和团队一起无缝自动维护一个项目内部文档了!
147154

148-
## 配置目标仓库
155+
### 配置目标仓库
149156

150157
RepoAgent目前支持对项目的文档生成和自动维护,因此需要对目标仓库进行一定的配置。
151158

0 commit comments

Comments
 (0)