doc: update documentation

pull/10/head
sean1832 1 year ago
parent 58933c67ab
commit e08b54ff88

@ -29,19 +29,23 @@
- [x] ~~支持多语言UI~~
- [x] ~~支持多语言检索。~~
- [ ] 提供详细操作指南。
- [ ] 自动更新。
- [ ] 发布windows版本。
## 安装
### 1. 所需条件
- 安装 **[python 3.11](https://www.python.org/downloads)** | [python 安装教程(Bilibili)](https://www.bilibili.com/video/BV1f3411t73m/?spm_id_from=333.337.search-card.all.click&vd_source=f96c4c534fe9f3ff6591942502d9d3a7)
- OpenAI **[API 密钥](https://platform.openai.com/account/api-keys)**需要注册OpenAI账号
- (可选) 安装 **[GitHub Desktop](https://desktop.github.com/)** 或者 **[Git](https://git-scm.com/downloads)** | [GitHub Desktop 安装教程(Bilibili)](https://www.bilibili.com/video/BV1Ns411M7dq/?spm_id_from=333.337.search-card.all.click&vd_source=f96c4c534fe9f3ff6591942502d9d3a7)
- (可选) 安装 **[Obsidian (黑曜石笔记)](https://obsidian.md/)**
### 2. 首次设置
1. 运行 `setup.bat`
1. 下载本仓库
1. 运行 `SETUP.bat`
2. 输入您的 OpenAI API 密钥
### 3. 运行
- 运行 `run-webUI.bat`
- 运行 `RUN.bat`
## demo

@ -29,19 +29,22 @@
- [x] ~~多言語UI。~~
- [x] ~~多言語検索に対応。~~
- [ ] ユーザー向けの詳細なドキュメントを提供する。
- [ ] 新バージョンの自動アップデート
- [ ] Windows用をリリース。
## 設置
### 1. 必要なもの
- **[python 3.11](https://www.python.org/downloads)** をインストール | [Pythonインストール方法解説 (YouTube)](https://youtu.be/HBxCHonP6Ro?t=105)
- OpenAI **[APIキー](https://platform.openai.com/account/api-keys)**
- OpenAI **[APIキー](https://platform.openai.com/account/api-keys)** の確保
- (オプショナル) **[GitHub Desktop](https://desktop.github.com/)** または **[Git](https://git-scm.com/downloads)** をインストール
- (オプショナル) **[Obsidian](https://obsidian.md/)** をインストール
### 2. 初めてのセットアップする
1. `setup.bat`を起動する。
2. OpenAI API キーを入力る。
1. このレポジトリをダウンロードする。
2. `SETUP.bat`を起動する。
3. OpenAI API キーを入力る。
### 3. プロジェクトを起動する
- `run-webUI.bat`を起動する。
- `RUN.bat`を起動する。
## デモ

@ -29,19 +29,22 @@
- [x] ~~Multilingual support for UI.~~
- [x] ~~Multilingual search support.~~
- [ ] Provide detail documentation for users.
- [ ] Automatic update for new version.
- [ ] Release for windows.
## Install
### 1. What you need
- Install **[python 3.11](https://www.python.org/downloads)** | [python installation tutorial (YouTube)](https://youtu.be/HBxCHonP6Ro?t=105)
- OpenAI **[API keys](https://platform.openai.com/account/api-keys)**
- **[GitHub Desktop](https://desktop.github.com/)** or **[Git](https://git-scm.com/downloads)** (optional)
- **[Obsidian](https://obsidian.md/)** (optional)
### 2. Set up the project for the first time
1. Run `setup.bat`
2. Enter your OpenAI API Key
1. Download the project
2. Run `SETUP.bat`
3. Enter your OpenAI API Key
### 3. Run
- Execute `run-webUI.bat`
- Execute `RUN.bat`
## Demo
![](Documentation/images/demo_menu_en.gif)

Loading…
Cancel
Save