Keldos commited on
Commit
0b80fd7
1 Parent(s): f90157b

doc: update README and ISSUE_TEMPLATE

Browse files
.github/ISSUE_TEMPLATE/feature-request.md CHANGED
@@ -2,7 +2,7 @@
2
  name: Feature request
3
  about: 请求更多功能!
4
  title: "[功能请求] 简明描述你想要增加的功能"
5
- labels: enhancement
6
  assignees: ''
7
 
8
  ---
 
2
  name: Feature request
3
  about: 请求更多功能!
4
  title: "[功能请求] 简明描述你想要增加的功能"
5
+ labels: feature request
6
  assignees: ''
7
 
8
  ---
.github/ISSUE_TEMPLATE/report-localhost.md CHANGED
@@ -2,7 +2,7 @@
2
  name: Report localhost
3
  about: 报告本地部署时的错误
4
  title: "[本地部署] 简短的错误描述"
5
- labels: local deployment
6
  assignees: ''
7
 
8
  ---
@@ -11,7 +11,7 @@ assignees: ''
11
  如果你不知道怎么填写,请先点击编辑框上方的“Preview”在预览中查看我们的说明,然后在空白行处填写信息~
12
 
13
  ### 错误描述
14
- > 请简明描述该错误。
15
 
16
  ### 复现操作
17
  > 你之前干了什么,然后出现了错误呢?例如:
 
2
  name: Report localhost
3
  about: 报告本地部署时的错误
4
  title: "[本地部署] 简短的错误描述"
5
+ labels: question, local deployment
6
  assignees: ''
7
 
8
  ---
 
11
  如果你不知道怎么填写,请先点击编辑框上方的“Preview”在预览中查看我们的说明,然后在空白行处填写信息~
12
 
13
  ### 错误描述
14
+ > 请简明描述该错误。另外,请注意替换issue标题中的“简短的错误描述”。
15
 
16
  ### 复现操作
17
  > 你之前干了什么,然后出现了错误呢?例如:
README.md CHANGED
@@ -48,12 +48,6 @@
48
  - 在Hugging Face上使用时,建议在右上角**复制Space**再使用,这样能大大减少排队时间,App反应也会更加迅速。
49
  <img width="300" alt="image" src="https://user-images.githubusercontent.com/51039745/223447310-e098a1f2-0dcf-48d6-bcc5-49472dd7ca0d.png">
50
 
51
-
52
- ## 已知问题
53
-
54
- 在代码块中输出Shell脚本存在问题,主要是撇号(`)被Markdown转义导致的。如果你知道怎么修复这个bug,欢迎提交PR ^_^
55
-
56
-
57
  ## 安装方式
58
 
59
  ### 本地部署
@@ -85,7 +79,9 @@
85
 
86
  <details><summary>3. 在文件中设定默认密钥、用户名密码</summary>
87
 
88
- 这样设置的密钥可以在项目更新之后保留。
 
 
89
 
90
  在`api_key.txt`中填写你的API-Key,注意不要填写任何无关内容。
91
 
@@ -168,7 +164,7 @@ docker build -t chuanhuchatgpt:latest .
168
 
169
  ## 部署相关
170
 
171
- <details><summary>如果需要在公网服务器部署本项目,可以查看。</summary>
172
 
173
  ### 部署到公网服务器
174
 
@@ -229,7 +225,14 @@ map $http_upgrade $connection_upgrade {
229
 
230
  ## 疑难杂症解决
231
 
232
- 首先,请尝试重装 gradio:
 
 
 
 
 
 
 
233
 
234
  ```
235
  pip install gradio --upgrade --force-reinstall
 
48
  - 在Hugging Face上使用时,建议在右上角**复制Space**再使用,这样能大大减少排队时间,App反应也会更加迅速。
49
  <img width="300" alt="image" src="https://user-images.githubusercontent.com/51039745/223447310-e098a1f2-0dcf-48d6-bcc5-49472dd7ca0d.png">
50
 
 
 
 
 
 
 
51
  ## 安装方式
52
 
53
  ### 本地部署
 
79
 
80
  <details><summary>3. 在文件中设定默认密钥、用户名密码</summary>
81
 
82
+ 这样设置的密钥可以在拉取项目更新之后保留。
83
+
84
+ 在项目文件夹中新建这两个文件:`api_key.txt` 和 `auth.json`。
85
 
86
  在`api_key.txt`中填写你的API-Key,注意不要填写任何无关内容。
87
 
 
164
 
165
  ## 部署相关
166
 
167
+ <details><summary>如果需要在公网服务器部署本项目,可以阅读本部分。</summary>
168
 
169
  ### 部署到公网服务器
170
 
 
225
 
226
  ## 疑难杂症解决
227
 
228
+ 首先,请尝试拉取本项目的最新更改,使用最新的代码重试。
229
+
230
+ 点击网页上的 `Download ZIP` 下载最新代码,或
231
+ ```shell
232
+ git pull https://github.com/GaiZhenbiao/ChuanhuChatGPT.git main -f
233
+ ```
234
+
235
+ 如果还有问题,可以再尝试重装 gradio:
236
 
237
  ```
238
  pip install gradio --upgrade --force-reinstall