From f6ce3f74840ea96c91cfe41733e7a1010bfda213 Mon Sep 17 00:00:00 2001
From: Wu <2321141691@qq.com>
Date: Sun, 2 Apr 2023 16:26:57 +0800
Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0README?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
README.md | 38 ++++++++++++++++++++++++++++++++++++--
main.py | 8 ++++----
static/example1.png | Bin 0 -> 63384 bytes
static/example2.png | Bin 0 -> 26512 bytes
static/example3.png | Bin 0 -> 51340 bytes
5 files changed, 40 insertions(+), 6 deletions(-)
create mode 100644 static/example1.png
create mode 100644 static/example2.png
create mode 100644 static/example3.png
diff --git a/README.md b/README.md
index f4ba066..f6d317f 100644
--- a/README.md
+++ b/README.md
@@ -11,6 +11,11 @@
· 音频转文字
· 一键启动
· 聊天记录保存
+· 快速响应
+
+### 启动之前
+1. 准备好你的 [OpenAI API Key](https://platform.openai.com/account/api-keys)
+2. 在系统环境变量中新增一条变量```OPENAI_API_KEY```，变量值为你的[OpenAI API Key](https://platform.openai.com/account/api-keys)
### 启动项目
1. 下载项目到本地
@@ -26,7 +31,7 @@
D:\code\ChatGPT-CLI\Virtualenv\Scripts\python.exe D:\code\ChatGPT-CLI\main.py
PAUSE
```
-2. 在系统环境变量中新增chat.bat的地址，即可在cmd中输入chat命令快速启动项目
+2. 在系统环境变量PATH中新增chat.bat的地址，即可在cmd中输入chat命令快速启动项目
@@ -45,6 +50,9 @@ PAUSE
+### 项目配置
+在使用前
+
### 如何使用
该项目共有五个选项```chat file save image audio```，当程序提示```Action```时即可输入选项并进入对应的模式，输入```quit```可以退出该程序，也可以直接关闭程序:D，接下来将分别介绍各个选项的作用：
#### chat
@@ -58,4 +66,30 @@ PAUSE
#### audio
输入音频文件的路径，返回该音频翻译的文字内容
-**注意**：所有选项都可以通过输入```quit```返回主菜单
\ No newline at end of file
+**注意**：所有选项都可以通过输入```quit```返回主菜单
+
+### 自定义程序
+修改main.py文件中的部分代码来定制化你的聊天机器人:D
+```python
+system_prompt: str = "You are a helpful assistant."
+model: str = "gpt-3.5-turbo"
+temperature: int = 1
+n: int = 1
+stream: bool = True
+stop: bytes = None
+max_tokens: int = 2048
+presence_penalty: int = 0
+frequency_penalty: int = 0
+```
+参数的具体含义参考[OpenAI API官网](https://platform.openai.com/docs/api-reference)
+
+### 使用截图
+
+
+
+
+
+
+
