From 444705b04862fc1709b47e299bb77cb270550651 Mon Sep 17 00:00:00 2001 From: rex <1073853456@qq.com> Date: Wed, 15 May 2024 00:50:58 +0800 Subject: [PATCH] update images of readme --- README-en.md | 32 ++++++++++++++++++++++++-------- README.md | 38 +++++++++++++++++++++++++++----------- 2 files changed, 51 insertions(+), 19 deletions(-) diff --git a/README-en.md b/README-en.md index 4b71d34..f36cd37 100644 --- a/README-en.md +++ b/README-en.md @@ -25,11 +25,15 @@ AskChat is a command-line tool for ChatGPT interaction, allowing you to call Cha Run in the terminal: -![hello](docs/assets/svgs/hello.svg) +
+hello +
Run in Jupyter Notebook: -![jupyter](docs/assets/jupyter.gif) +
+jupyter +
## Installation and Configuration @@ -66,19 +70,27 @@ In addition, you can use `askchat` for more flexible dialogue and `askenv` to ma 1. API debugging, testing default parameters and return results. - ![debug](docs/assets/svgs/debug.svg) +
+ debug +
2. Get a list of available models. - ![validmodels](docs/assets/svgs/validmodels.svg) +
+ validmodels +
3. Multi-turn dialogue, saving dialogues, loading dialogues, etc. - ![chatlog](docs/assets/svgs/chatlog.svg) +
+ chatlog +
4. Specify parameters, using different models and APIs. - ![para-models](docs/assets/svgs/para-models.svg) +
+ para-models +
### Dialogue Management @@ -136,11 +148,15 @@ Note: `--all-valid-models` will print all available models, including Embedding, 1. Create, view, activate, and delete channels. - ![askenv](docs/assets/svgs/askenv.svg) +
+ askenv +
2. Edit channel. - ![askenv-config](docs/assets/svgs/editenv.svg) +
+ editenv +
### Basic Usage diff --git a/README.md b/README.md index c19b752..6d2433b 100644 --- a/README.md +++ b/README.md @@ -21,15 +21,19 @@ [English](README-en.md) | [简体中文](README.md) -AskChat 是一个通过命令行运行的,无界面的 ChatGPT 交互工具,随时随地调用 ChatGPT。 +AskChat 是一个命令行运行的无界面的 ChatGPT 交互工具,随时随地调用 ChatGPT。 -在终端调用: +终端调用: -![hello](docs/assets/svgs/hello.svg) +
+hello +
-在 Jupyter Notebook 中调用: +Jupyter Notebook 调用: -![jupyter](docs/assets/jupyter.gif) +
+jupyter +
## 安装及配置 @@ -66,19 +70,27 @@ ask hello world 1. API 调试,测试默认参数和返回结果。 - ![debug](docs/assets/svgs/debug.svg) +
+ debug +
2. 获取可用模型列表。 - ![validmodels](docs/assets/svgs/validmodels.svg) +
+ validmodels +
3. 多轮对话,保存对话,加载对话等。 - ![chatlog](docs/assets/svgs/chatlog.svg) +
+ chatlog +
4. 指定参数,使用不同的模型和 API。 - ![para-models](docs/assets/svgs/para-models.svg) +
+ para-models +
### 对话管理 @@ -134,11 +146,15 @@ ask hello world 1. 创建,查看,激活和删除渠道 - ![askenv](docs/assets/svgs/askenv.svg) +
+ askenv +
2. 编辑渠道 - ![askenv-config](docs/assets/svgs/editenv.svg) +
+ editenv +
### 基本用法