diff --git a/README-en.md b/README-en.md index 4b71d34..c2a045c 100644 --- a/README-en.md +++ b/README-en.md @@ -23,13 +23,19 @@ AskChat is a command-line tool for ChatGPT interaction, allowing you to call ChatGPT anytime, anywhere. -Run in the terminal: - -![hello](docs/assets/svgs/hello.svg) - -Run in Jupyter Notebook: +
+
+
Run in Terminal
+ hello +
+
-![jupyter](docs/assets/jupyter.gif) +
+
+
Jupyter Lab
+ jupyter +
+
## Installation and Configuration @@ -64,21 +70,33 @@ In addition, you can use `askchat` for more flexible dialogue and `askenv` to ma ### Usage Examples -1. API debugging, testing default parameters and return results. - - ![debug](docs/assets/svgs/debug.svg) - -2. Get a list of available models. - - ![validmodels](docs/assets/svgs/validmodels.svg) - -3. Multi-turn dialogue, saving dialogues, loading dialogues, etc. +
+
+
1. API debugging
+ debug +
+
- ![chatlog](docs/assets/svgs/chatlog.svg) +
+
+
2. Get a list of available models
+ validmodels +
+
-4. Specify parameters, using different models and APIs. +
+
+
3. Multi-turn dialogue, saving dialogues, loading dialogues, etc.
+ chatlog +
+
- ![para-models](docs/assets/svgs/para-models.svg) +
+
+
4. Specify parameters, using different models and APIs
+ para-models +
+
### Dialogue Management @@ -121,9 +139,7 @@ Auxiliary features, such as generating configuration files, debugging logs, prin | `--generate-config` | `askchat --generate-config` | Generate a configuration file, saved in `~/.askchat/.env` | | `--debug` | `askchat --debug` | Print debugging logs | | `--valid-models` | `askchat --valid-models` | Print a list of models containing "gpt" in their names | -| `--all - --valid-models` | `askchat --all-valid-models` | Print all available models | +| `--all-valid-models` | `askchat --all-valid-models` | Print all available models | | `--version` | `askchat -v` | Version information of `askchat` | Note: `--all-valid-models` will print all available models, including Embedding, dalle-3, tts, etc., use `--valid-models` to filter these out. @@ -134,14 +150,19 @@ Note: `--all-valid-models` will print all available models, including Embedding, ### Examples -1. Create, view, activate, and delete channels. - - ![askenv](docs/assets/svgs/askenv.svg) - -2. Edit channel. - - ![askenv-config](docs/assets/svgs/editenv.svg) +
+
+
1. Create channel
+ askenv +
+
+
+
+
2. Edit channel
+ editenv +
+
### Basic Usage diff --git a/README.md b/README.md index c19b752..0032309 100644 --- a/README.md +++ b/README.md @@ -21,15 +21,17 @@ [English](README-en.md) | [简体中文](README.md) -AskChat 是一个通过命令行运行的，无界面的 ChatGPT 交互工具，随时随地调用 ChatGPT。 +通过命令行运行的 ChatGPT 交互工具，随时随地调用 ChatGPT。 -在终端调用： - -![hello](docs/assets/svgs/hello.svg) - -在 Jupyter Notebook 中调用： +
+
终端调用
+ hello +
-![jupyter](docs/assets/jupyter.gif) +
+
Jupyter Lab
+ jupyter +
## 安装及配置 @@ -64,21 +66,25 @@ ask hello world ### 使用示例 -1. API 调试，测试默认参数和返回结果。 - - ![debug](docs/assets/svgs/debug.svg) - -2. 获取可用模型列表。 - - ![validmodels](docs/assets/svgs/validmodels.svg) - -3. 多轮对话，保存对话，加载对话等。 +
+
1. API 调试
+ debug +
- ![chatlog](docs/assets/svgs/chatlog.svg) +
+
2. 获取可用模型列表
+ validmodels +
-4. 指定参数，使用不同的模型和 API。 +
+
3. 多轮对话，保存对话，加载对话等
+ chatlog +
- ![para-models](docs/assets/svgs/para-models.svg) +
+
4. 指定参数，使用不同的模型和 API
+ para-models +
### 对话管理 @@ -132,14 +138,15 @@ ask hello world ### 示例 -1. 创建，查看，激活和删除渠道 - - ![askenv](docs/assets/svgs/askenv.svg) - -2. 编辑渠道 - - ![askenv-config](docs/assets/svgs/editenv.svg) +
+
1. 创建渠道
+ askenv +
+
+
2. 编辑渠道
+ editenv +
### 基本用法 @@ -192,6 +199,8 @@ ask hello world askenv config [name] [-a API_KEY] [-b BASE_URL] [--api-base API_BASE] [-m MODEL] ``` -## 问题和反馈 +## 问 + +题和反馈 使用过程中有任何问题或建议，欢迎提交 [Issue](https://github.com/cubenlp/askchat/issues)。 \ No newline at end of file