docs: update docs

This commit is contained in:
JinmingYang
2023-07-09 21:46:03 +08:00
parent f0e97f493d
commit aead8afe19
8 changed files with 12 additions and 10 deletions

View File

@@ -73,7 +73,7 @@ Use GPT-Runner to manage your AI presets, engage in AI-powered conversations wit
## Quick Start
> Make sure you have an Open AI Key or a Anthropic Key. You can get it from [Open AI](https://platform.openai.com/) or [Anthropic](https://www.anthropic.com/).
> Make sure you have an Open AI Key or a Anthropic Key. You can get it from [Open AI](https://platform.openai.com/account/api-keys) or [Anthropic](https://www.anthropic.com/).
### The first way: CLI

View File

@@ -68,7 +68,7 @@
## 快速开始
> 确保你有一个 Open AI Key 或 Anthropic Key如果没有请访问 [Open AI](https://platform.openai.com/) 或 [Anthropic](https://www.anthropic.com/product/) 申请。
> 确保你有一个 Open AI Key 或 Anthropic Key如果没有请访问 [Open AI](https://platform.openai.com/account/api-keys) 或 [Anthropic](https://www.anthropic.com/product/) 申请。
> 2. 确保你的命令终端能 ping 通 google.com (如果你在中国大陆,你可能需要科学上网)。
### 方式一CLI

View File

@@ -46,7 +46,7 @@ GPT-Runner CLI 是一款功能强大的命令行工具,可帮助您管理 AI
> 1. Requirements NodeJS >= 16.15.0
> - To check your NodeJS version, run `node -v` in your terminal. If you need to install or update NodeJS, visit [the official NodeJS website](https://nodejs.org/) for download and installation instructions.
> 2. Make sure you have an Open AI Key or a Anthropic Key. You can get it from [Open AI](https://platform.openai.com/) or [Anthropic](https://www.anthropic.com/).
> 2. Make sure you have an Open AI Key or a Anthropic Key. You can get it from [Open AI](https://platform.openai.com/account/api-keys) or [Anthropic](https://www.anthropic.com/).
> 3. Slow installation is normal, because the package is a bit big.
To install the GPT-Runner CLI, use npm:

View File

@@ -43,7 +43,7 @@ GPT-Runner CLI 是一款功能强大的命令行工具,可帮助您管理 AI
> 1. 要求 NodeJS >= 16.15.0
> - 要检查您的 NodeJS 版本,在终端运行 `node -v` 。如果需要安装或更新 NodeJS ,请访问[官方 NodeJS 网站](https://nodejs.org/)以获取下载和安装指南。
> 2. 确保你有一个 Open AI Key 或 Anthropic Key如果没有请访问 [Open AI](https://platform.openai.com/) 或 [Anthropic](https://www.anthropic.com/product/) 申请。
> 2. 确保你有一个 Open AI Key 或 Anthropic Key如果没有请访问 [Open AI](https://platform.openai.com/account/api-keys) 或 [Anthropic](https://www.anthropic.com/product/) 申请。
> 3. 确保你的命令终端能 ping 通 google.com (如果你在中国大陆,你可能需要科学上网)。
> 4. 安装速度较慢是正常的,因为软件包体积较大。

View File

@@ -46,7 +46,7 @@ This extension helps you manage AI presets and drive conversations with code usi
## Installation
> 1. Requires VSCode >= 1.72.0
> 2. Make sure you have an Open AI Key or Anthropic Key. If you do not have, please visit [Open AI](https://platform.openai.com/) or [Anthropic](https://www.anthropic.com/product/) to apply.
> 2. Make sure you have an Open AI Key or Anthropic Key. If you do not have, please visit [Open AI](https://platform.openai.com/account/api-keys) or [Anthropic](https://www.anthropic.com/product/) to apply.
You can search `GPT Runner` in the VSCode Extension Marketplace for installation.

View File

@@ -47,7 +47,7 @@ GPT-Runner VSCode 扩展是 GPT-Runner 跟 VSCode 深度结合的结果。
## 安装
> 1. 要求 VSCode >= 1.72.0
> 2. 确保你有一个 Open AI Key 或 Anthropic Key如果没有请访问 [Open AI](https://platform.openai.com/) 或 [Anthropic](https://www.anthropic.com/product/) 申请。
> 2. 确保你有一个 Open AI Key 或 Anthropic Key如果没有请访问 [Open AI](https://platform.openai.com/account/api-keys) 或 [Anthropic](https://www.anthropic.com/product/) 申请。
你可以在 VSCode 扩展市场搜索 `GPT Runner` 进行安装。

View File

@@ -1,6 +1,8 @@
# Gpt-runner Web
Gpt-runner Web is the web interface of GPT-Runner.
**You can use `GPT-Runner Web` in `GPT-Runner CLI` or `GPT-Runner VSCode extension`**
GPT-Runner Web is the web interface of GPT-Runner.
It contains both server side and client side code.

View File

@@ -19,9 +19,9 @@ export default defineConfig(async () => {
return {
root: resolvePath('./'),
publicDir: resolvePath('./public'),
optimizeDeps: {
include: ['@nicepkg/gpt-runner-shared'],
},
// optimizeDeps: {
// include: ['@nicepkg/gpt-runner-shared'],
// },
plugins: [
React(),
Svgr(),