docs: update docs

2023-07-09 23:22:36 +08:00
parent aead8afe19
commit e17ae81ba6
14 changed files with 428 additions and 221 deletions
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1 +1,206 @@
-Please refer to https://github.com/antfu/contribute
+# Contribution Guide
+
+Hey there! We are really excited that you are interested in contributing. Before submitting your contribution, please make sure to take a moment and read through the following guide:
+
+## 👨‍💻 Repository Setup
+
+1. Fork the repo (click the <kbd>Fork</kbd> button at the top right of
+   [this page](https://github.com/nicepkg/gpt-runner))
+
+2. Clone your fork locally
+
+```sh
+git clone https://github.com/<your_github_username>/gpt-runner.git
+cd gpt-runner
+```
+
+3. Install Dependencies. This project depends on node v16.15.0+ and pnpm 8.x
+
+If you don't have pnpm installed, you should execute:
+
+We use [`pnpm`](https://pnpm.io/) for this projects.
+
+To install pnpm, you can
+
+```bash
+npm i -g pnpm
+
+# check node version
+node -v
+
+# check pnpm version
+pnpm -v
+```
+
+## 💡 Commands
+
+### `pnpm dev`
+
+Start the development environment.
+
+It will start the  [stub the passive watcher when using `unbuild`](https://antfu.me/posts/publish-esm-and-cjs#stubbing).
+
+### `pnpm build`
+
+Build the project for production. The result is usually under `dist/`.
+
+### `pnpm lint`
+
+We use [ESLint](https://eslint.org/) for **both linting and formatting**. It also lints for JSON, YAML and Markdown files if exists.
+
+You can run `pnpm lint --fix` to let ESLint formats and lints the code.
+
+Learn more about the [ESLint Setup](#eslint).
+
+[**We don't use Prettier**](#no-prettier).
+
+### `pnpm test`
+
+~~Run the tests. We mostly using [Vitest](https://vitest.dev/) - a replacement of [Jest](https://jestjs.io/).~~
+
+**Current We Don't Have Test**
+
+## 📦 Packages
+
+### `@nicepkg/gpt-runner`
+
+Only for `gptr.config.ts` file `defineConfig` type tips
+
+### `@nicepkg/gpt-runner-core`
+
+This is the main package that contains the core logic of the project.
+
+### `@nicepkg/gpt-runner-cli`
+
+This is the CLI package that contains the CLI logic of the project.
+
+### `@nicepkg/gpt-runner-shared`
+
+This is the shared package that contains the shared logic of the project.
+
+### `@nicepkg/gpt-runner-vscode`
+
+This is the VSCode extension package that contains the VSCode extension logic of the project.
+
+#### How To Dev VSCode Extension
+
+1. Run `cd packages/gpt-runner-vscode`
+2. Run `pnpm dev` (Before it, You need to run `pnpm build` in the root directory first)
+3. Run `code .` to open the project in another window of VSCode
+4. Press <kbd>F5</kbd> to start the extension in debug mode
+
+#### How To Build VSIX
+
+1. Run `cd packages/gpt-runner-vscode`
+2. Run `pnpm build:vsix` (Before it, You need to run `pnpm build` in the root directory first)
+3. You can find the `gpt-runner.vsix` file in the `packages/gpt-runner-vscode/dist` directory
+4. Right click the `gpt-runner.vsix` file and select `Install Extension VSIX...` to install the extension
+
+### `@nicepkg/gpt-runner-web`
+
+This is the Web package that contains both the server side and client side logic of the project.
+
+#### How To Dev Web
+
+1. Run `cd packages/gpt-runner-web`
+2. Run `pnpm dev:server` (Before it, You need to run `pnpm dev` in the root directory first)
+3. Run `pnpm dev:client`
+4. open `http://localhost:3006` in your browser
+
+## 🙌 Sending Pull Request
+
+### Discuss First
+
+Before you start to work on a feature pull request, it's always better to open a feature request issue first to discuss with the maintainers whether the feature is desired and the design of those features. This would help save time for both the maintainers and the contributors and help features to be shipped faster.
+
+For typo fixes, it's recommended to batch multiple typo fixes into one pull request to maintain a cleaner commit history.
+
+### Commit Convention
+
+We use [Conventional Commits](https://www.conventionalcommits.org/) for commit messages, which allows the changelog to be auto-generated based on the commits. Please read the guide through if you aren't familiar with it already.
+
+Only `fix:` and `feat:` will be presented in the changelog.
+
+Note that `fix:` and `feat:` are for **actual code changes** (that might affect logic).
+For typo or document changes, use `docs:` or `chore:` instead:
+
+- ~~`fix: typo`~~ -> `docs: fix typo`
+
+### Pull Request
+
+If you don't know how to send a Pull Request, we recommend reading [the guide](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request).
+
+When sending a pull request, make sure your PR's title also follows the [Commit Convention](#commit-conventions).
+
+If your PR fixes or resolves an existing issue, please add the following line in your PR description (replace `123` with a real issue number):
+
+```markdown
+fix #123
+```
+
+This will let GitHub know the issues are linked, and automatically close them once the PR gets merged. Learn more at [the guide](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword).
+
+It's ok to have multiple commits in a single PR, you don't need to rebase or force push for your changes as we will use `Squash and Merge` to squash the commits into one commit when merging.
+
+## 🧑‍🔧 Maintenance
+
+This section is for maintainers with write access, or if you want to maintain your own forks.
+
+### Update Dependencies
+
+Keeping dependencies up-to-date is one of the important aspects to keep projects alive and getting latest bug fixes on time. We recommend to update dependencies in weekly or bi-weekly intervals.
+
+We use [`taze`](https://github.com/antfu/taze) to update the dependencies manually most of the time. As deps updating bots like [Dependabot](https://github.com/dependabot) or [Renovate](https://renovatebot.com/) could be a bit annoying when you have a lot projects.
+
+With `taze`, you can run `pnpm taze major -Ir` to check and select the versions to update interactive. `-I` stands for `--interactive`, `-r` stands for `--recursive` for monorepo.
+
+After bumpping, we install them, runing build and test to verify nothing breaks before pushing to main.
+
+### Releasing
+
+Before you do, make sure you have lastest git commit from upstream and all CI passes.
+
+We do `pnpm release`. It will prompts a list for the target version you want to release. After select, it will bump your package.json and commit the changes with git tag, powered by [`bumpp`](https://github.com/antfu/bumpp).
+
+#### Build on CI
+
+They will be triggered by the `v` prefixed git tag added by `bumpp`. The action is usually defined under `.github/workflows/release.yml`
+
+> When maintaining your own fork, you might need to see `NPM_TOKEN` secret to your repository for it to publish the packages.
+
+Changelogs are always generated by GitHub Actions.
+
+## 📖 References
+
+### ESLint
+
+We use [ESLint](https://eslint.org/) for both linting and formatting with [`@antfu/eslint-config`](https://github.com/antfu/eslint-config).
+
+<table><tr><td width="500px" valign="top">
+
+#### IDE Setup
+
+We recommend using [VS Code](https://code.visualstudio.com/) along with the [ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint).
+
+With the settings on the right, you can have auto fix and formatting when you save the code you are editing.
+
+</td><td width="500px"><br>
+
+VS Code's `settings.json`
+
+```json
+{
+  "editor.codeActionsOnSave": {
+    "source.fixAll": false,
+    "source.fixAll.eslint": true
+  }
+}
+```
+
+</td></tr></table>
+
+### No Prettier
+
+Since ESLint is already configured to format the code, there is no need to duplicate the functionality with Prettier ([*Why don't use prettier*](https://antfu.me/posts/why-not-prettier)). To format the code, you can run `pnpm lint --fix` or referring the [ESLint section](#eslint) for IDE Setup.
+
+If you have Prettier installed in your editor, we recommend you disable it when working on the project to avoid conflict.
--- a/2
+++ b/2
@@ -19,3 +19,5 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
+
+很好，我理解你想要让 `docs/gpt-config.en.md` 文件更具吸引力。下面是我为你添加了 Emoji 后的建议：
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@

 <h1 align="center">GPT Runner</h1>

-English / [简体中文](https://github.com/nicepkg/gpt-runner/tree/main/README_CN.md)
+English / [简体中文 🌏](https://github.com/nicepkg/gpt-runner/tree/main/README_CN.md)

 Use GPT-Runner to manage your AI presets, engage in AI-powered conversations with your code, and significantly boost the development efficiency of both you and your team!

@@ -30,48 +30,48 @@ Use GPT-Runner to manage your AI presets, engage in AI-powered conversations wit
 </div>

 <details>
-<summary>Table of Contents</summary><br>
+<summary>📚 Table of Contents</summary><br>

- [Why GPT-Runner?](#why-gpt-runner)
- [Features](#features)
- [Quick Start](#quick-start)
+- [🤷‍♂️ Why GPT-Runner?](#️-why-gpt-runner)
+- [⚙️ Features](#️-features)
+- [🚀 Quick Start](#-quick-start)
  - [The first way: CLI](#the-first-way-cli)
  - [The second way:  VSCode Extension](#the-second-way--vscode-extension)
- [Documentation](#documentation)
+- [📖 Documentation](#-documentation)
  - [GPT-Runner Configs And AI Preset Files](#gpt-runner-configs-and-ai-preset-files)
  - [GPT-Runner Ui Usage](#gpt-runner-ui-usage)
- [Road map](#road-map)
- [What's New](#whats-new)
- [FAQ](#faq)
- [Sponsor](#sponsor)
- [Contributor](#contributor)
- [Acknowledgement](#acknowledgement)
- [LICENSE](#license)
+- [🗒️ Road map](#️-road-map)
+- [🆕 What's New](#-whats-new)
+- [❓ FAQ](#-faq)
+- [💖 Sponsor](#-sponsor)
+- [🤝 Contributor](#-contributor)
+- [🙏 Acknowledgement](#-acknowledgement)
+- [📜 LICENSE](#-license)

 <br></details>

-## Why GPT-Runner?
+## 🤷‍♂️ Why GPT-Runner?

-1. **Conversations with Code Files:** 
-    - Before using GPT-Runner: Manual copy and paste of multiple file codes into the ChatGPT window were required to propose features or fix bugs to AI.
-    - After using GPT-Runner: Simply select your project files from the file tree. The AI will provide responses based on the most recent contents of those files.
+1. **🔍 Conversations with Code Files:** 
+    - Before using GPT-Runner: Manual copy and paste of multiple file codes into the ChatGPT window were required to propose features or fix bugs to AI.🙁
+    - After using GPT-Runner: Simply select your project files from the file tree. The AI will provide responses based on the most recent contents of those files.🤩

-2. **Manage the Project's AI Presets:** 
-    - Before using GPT-Runner: Project prompts saved in memos needed to be copied and pasted to ChatGPT for inquiries, making it difficult to put them under git version control.
-    - After using GPT-Runner: Each [xxx.gpt.md](https://github.com/nicepkg/gpt-runner/tree/main/docs/examples/example-en.gpt.md) file represents an AI role preset. They are easy to read, modify, and can be version-controlled. Team members can share and enhance AI presets, making the code they produce closer to 100% usability.
+2. **📑 Manage the Project's AI Presets:** 
+    - Before using GPT-Runner: Project prompts saved in memos needed to be copied and pasted to ChatGPT for inquiries, making it difficult to put them under git version control.🤪
+    - After using GPT-Runner: Each [xxx.gpt.md](https://github.com/nicepkg/gpt-runner/tree/main/docs/examples/example-en.gpt.md) file represents an AI role preset. They are easy to read, modify, and can be version-controlled. Team members can share and enhance AI presets, making the code they produce closer to 100% usability.🥰


-## Features
+## ⚙️ Features

- **Conversations with Code Files**: Select files or folders and engage in real-time conversations with AI.
- **Powerful CLI and IDE integration:** Implement efficient AI workflows in various IDEs.
- **AI Preset Manager:** Manage your AI presets, Just like a locally Storybook for AI presets.
- **Customize AI parameters:** Flexibly control the configuration of AI models.
- **Support for third-party LLMs:** High compatibility and adaptability.
- **Privacy-first:** Local data storage protects your privacy.
- **Locale support:** Support for multiple languages.
+- **🔍 Conversations with Code Files**: Select files or folders and engage in real-time conversations with AI.
+- **🛠️ Powerful CLI and IDE integration:** Implement efficient AI workflows in various IDEs.
+- **🔖 AI Preset Manager:** Manage your AI presets, Just like a locally Storybook for AI presets.
+- **🤖 Customize AI parameters:** Flexibly control the configuration of AI models.
+- **🔌 Support for third-party LLMs:** High compatibility and adaptability.
+- **🔒 Privacy-first:** Local data storage protects your privacy.
+- **🌎 Locale support:** Support for multiple languages.

-## Quick Start
+## 🚀 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/account/api-keys) or [Anthropic](https://www.anthropic.com/).

@@ -96,7 +96,7 @@ You can see the web interface in your browser at [http://localhost:3003](http://

 Install the [GPT-Runner VSCode Extension](https://marketplace.visualstudio.com/items?itemName=nicepkg.gpt-runner) from the VSCode Marketplace.

-## Documentation
+## 📖 Documentation

 ### GPT-Runner Configs And AI Preset Files

@@ -108,7 +108,7 @@ For details about `gptr.config.json` configuration file, `xxx.gpt.md` AI preset

 [Introduction to GPT-Runner Ui Usage](https://github.com/nicepkg/gpt-runner/blob/main/docs/ui-usage.en.md)

-## Road map
+## 🗒️ Road map

 - [ ] Jetbrains Plugin: Add Jetbrains IDE Plugin
 - [ ] Export And Import Chat History: Add dialogue import and export function
@@ -116,19 +116,19 @@ For details about `gptr.config.json` configuration file, `xxx.gpt.md` AI preset
 - [ ] Template Interpolation: Add template interpolation support
 - [ ] Electron: Add an Electron client to expand the target audience to non-developers

-## What's New
+## 🆕 What's New

 - 🚀 v1.0.0: First Release

-## FAQ
+## ❓ FAQ

 [English > FAQ](https://github.com/nicepkg/gpt-runner/tree/main/docs/faq.en.md)

-## Sponsor
+## 💖 Sponsor

 Waiting for you...

-## Contributor
+## 🤝 Contributor

 You can check out our [Contribution Guidelines](https://github.com/nicepkg/gpt-runner/tree/main/CONTRIBUTING.md)

@@ -138,7 +138,7 @@ This project exists thanks to all the people who contribute:
  <img src="https://contrib.rocks/image?repo=nicepkg/gpt-runner" />
 </a>

-## Acknowledgement
+## 🙏 Acknowledgement

 GPT-Runner is made possible thanks to the inspirations from the following projects:

@@ -150,6 +150,6 @@ GPT-Runner is made possible thanks to the inspirations from the following projec
 - [UnoCss](https://github.com/unocss/unocss)
 - [VSCode-Webview-Ui-Toolkit](https://github.com/microsoft/vscode-webview-ui-toolkit)

-## LICENSE
+## 📜 LICENSE

 [MIT](https://github.com/nicepkg/gpt-runner/tree/main/LICENSE) License &copy; 2023-PRESENT [Jinming Yang](https://github.com/2214962083)
--- a/README_CN.md
+++ b/README_CN.md
@@ -3,7 +3,7 @@

 <h1 align="center">GPT Runner</h1>

-[English](https://github.com/nicepkg/gpt-runner/tree/main/README.md) / 简体中文
+[English 🌏](https://github.com/nicepkg/gpt-runner/tree/main/README.md) / 简体中文

 用 GPT-Runner 管理您的 AI 预设，通过 AI 与您的代码文件聊天，极大提升您和团队的开发效率！

@@ -26,47 +26,47 @@
 </div>

 <details>
-<summary>目录</summary><br>
+<summary>📚 目录</summary><br>

- [为什么选择 GPT-Runner？](#为什么选择-gpt-runner)
- [主要功能](#主要功能)
- [快速开始](#快速开始)
+- [🤷‍♂️ 为什么选择 GPT-Runner？](#️-为什么选择-gpt-runner)
+- [⚙️ 主要功能](#️-主要功能)
+- [🚀 快速开始](#-快速开始)
  - [方式一：CLI](#方式一cli)
  - [方式二：VSCode 扩展](#方式二vscode-扩展)
- [文档](#文档)
+- [📖 文档](#-文档)
  - [GPT-Runner 配置和 AI 预设文件](#gpt-runner-配置和-ai-预设文件)
  - [GPT-Runner Ui 用法](#gpt-runner-ui-用法)
- [开发计划](#开发计划)
- [最新动态](#最新动态)
- [常见问题](#常见问题)
- [赞助者](#赞助者)
- [贡献者](#贡献者)
- [鸣谢](#鸣谢)
- [许可证](#许可证)
+- [🗒️ 开发计划](#️-开发计划)
+- [🆕 最新动态](#-最新动态)
+- [❓ 常见问题](#-常见问题)
+- [💖 赞助者](#-赞助者)
+- [🤝 贡献者](#-贡献者)
+- [🙏 鸣谢](#-鸣谢)
+- [📜 许可证](#-许可证)

 <br></details>

-## 为什么选择 GPT-Runner？
+## 🤷‍♂️ 为什么选择 GPT-Runner？

-1. **与代码文件对话：** 
-    - 使用 GPT-Runner 前：必须手动复制多个文件代码到 ChatGPT 窗口，向 AI 提出需求或修复 bug 。
-    - 使用 GPT-Runner 后：只需在文件树中勾选项目文件，AI 将根据文件的最新内容为您提供解答！
+1. **🔍 与代码文件对话：** 
+    - 使用 GPT-Runner 前：必须手动复制多个文件代码到 ChatGPT 窗口，向 AI 提出需求或修复 bug 。🙁
+    - 使用 GPT-Runner 后：只需在文件树中勾选项目文件，AI 将根据文件的最新内容为您提供解答！🤩

-2. **管理项目的AI预设：** 
-    - 使用 GPT-Runner 前：保存在备忘录中的项目提示需要复制粘贴给 ChatGPT 才能提问，难以进行 git 版本管理。
-    - 使用 GPT-Runner 后：[xxx.gpt.md](https://github.com/nicepkg/gpt-runner/tree/main/docs/examples/example-cn.gpt.md) 文件代表一个AI角色预设，它易于阅读、修改并可进行版本控制。团队成员可以分享和优化 AI 预设，使其生成的代码更接近 100% 的可用性。
+2. **📑 管理项目的AI预设：** 
+    - 使用 GPT-Runner 前：保存在备忘录中的项目提示需要复制粘贴给 ChatGPT 才能提问，难以进行 git 版本管理。🤪
+    - 使用 GPT-Runner 后：[xxx.gpt.md](https://github.com/nicepkg/gpt-runner/tree/main/docs/examples/example-cn.gpt.md) 文件代表一个AI角色预设，它易于阅读、修改并可进行版本控制。团队成员可以分享和优化 AI 预设，使其生成的代码更接近 100% 的可用性。🥰

-## 主要功能
+## ⚙️ 主要功能

- **与代码文件对话：** 选择文件或文件夹与 AI 实时对话。
- **强大的 CLI 与 IDE 集成：** 在各种 IDE 中实现高效的 AI 工作流程。
- **管理你的 AI 预设：** 管理你的 AI 预设，它就像 AI 预设的本地 Storybook。
- **自定义 AI 参数：** 灵活控制 AI 模型的配置。
- **支持第三方 LLM：** 具有高度兼容性和适应性。
- **隐私优先：** 本地数据存储保护您的隐私。
- **国际化：** 支持多种语言。
+- **🔍 与代码文件对话：** 选择文件或文件夹与 AI 实时对话。
+- **🛠️ 强大的 CLI 与 IDE 集成：** 在各种 IDE 中实现高效的 AI 工作流程。
+- **🔖 管理你的 AI 预设：** 管理你的 AI 预设，它就像 AI 预设的本地 Storybook。
+- **🤖 自定义 AI 参数：** 灵活控制 AI 模型的配置。
+- **🔌 支持第三方 LLM：** 具有高度兼容性和适应性。
+- **🔒 隐私优先：** 本地数据存储保护您的隐私。
+- **🌎 国际化：** 支持多种语言。

-## 快速开始
+## 🚀 快速开始

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

 从 VSCode Marketplace 安装 [GPT-Runner VSCode 扩展](https://marketplace.visualstudio.com/items?itemName=nicepkg.gpt-runner)。

-## 文档
+## 📖 文档

 ### GPT-Runner 配置和 AI 预设文件

@@ -103,7 +103,7 @@ npx gptr

 [GPT-Runner Ui使用介绍](https://github.com/nicepkg/gpt-runner/blob/main/docs/ui-usage.cn.md)

-## 开发计划
+## 🗒️ 开发计划

 - [ ] Jetbrains 插件：添加 Jetbrains IDE 插件
 - [ ] 导出和导入聊天记录：添加对话导入导出功能
@@ -111,19 +111,19 @@ npx gptr
 - [ ] 模板插值：添加模板插值支持
 - [ ] Electron：添加 Electron 客户端，将目标受众推广到非开发人员

-## 最新动态
+## 🆕 最新动态

 - 🚀 v1.0.0: 首次发布

-## 常见问题
+## ❓ 常见问题

 [简体中文 > 常见问题](https://github.com/nicepkg/gpt-runner/tree/main/docs/faq.cn.md)

-## 赞助者
+## 💖 赞助者

 等待你的赞助...

-## 贡献者
+## 🤝 贡献者

 你可以查看我们的[贡献指南](https://github.com/nicepkg/gpt-runner/tree/main/CONTRIBUTING.md)

@@ -133,7 +133,7 @@ npx gptr
  <img src="https://contrib.rocks/image?repo=nicepkg/gpt-runner" />
 </a>

-## 鸣谢
+## 🙏 鸣谢

 感谢以下项目的启示，使 GPT-Runner 成为可能：

@@ -145,6 +145,6 @@ npx gptr
 - [UnoCss](https://github.com/unocss/unocss)
 - [VSCode-Webview-Ui-Toolkit](https://github.com/microsoft/vscode-webview-ui-toolkit)

-## 许可证
+## 📜 许可证

 [MIT](https://github.com/nicepkg/gpt-runner/tree/main/LICENSE) License &copy; 2023-PRESENT [Jinming Yang](https://github.com/2214962083)
--- a/docs/faq.cn.md
+++ b/docs/faq.cn.md
@@ -1,2 +1,2 @@
-# 常见问题
+# ❓ 常见问题

--- a/docs/faq.en.md
+++ b/docs/faq.en.md
@@ -1 +1 @@
-# FAQ
+# ❓ FAQ
--- a/docs/gpt-config.cn.md
+++ b/docs/gpt-config.cn.md
@@ -1,21 +1,21 @@
-# GPT-Runner 配置和 AI 预设文件
+# 📖 GPT-Runner 配置和 AI 预设文件

 <details>
-<summary>目录</summary><br>
+<summary> 📚 目录</summary><br>

- [GPT-Runner 配置和 AI 预设文件](#gpt-runner-配置和-ai-预设文件)
-  - [介绍](#介绍)
-    - [.gpt-runner 目录](#gpt-runner-目录)
-  - [gptr.config.ts/js/json 配置文件](#gptrconfigtsjsjson-配置文件)
-  - [xxx.gpt.md AI 预设文件](#xxxgptmd-ai-预设文件)
-  - [聊天模型配置](#聊天模型配置)
+- [📖 GPT-Runner 配置和 AI 预设文件](#-gpt-runner-配置和-ai-预设文件)
+  - [✨ 介绍](#-介绍)
+    - [📂 .gpt-runner 目录](#-gpt-runner-目录)
+  - [📄 gptr.config.ts/js/json 配置文件](#-gptrconfigtsjsjson-配置文件)
+  - [📑 xxx.gpt.md AI 预设文件](#-xxxgptmd-ai-预设文件)
+  - [🤖 聊天模型配置](#-聊天模型配置)
    - [OpenAI](#openai)
    - [Anthropic](#anthropic)
- [其他](#其他)
+- [🔍 其他](#-其他)

 <br></details>

-## 介绍
+## ✨ 介绍

 1. 当你启动 GPT-Runner 时，它会读先读取项目级配置文件。
   
@@ -41,7 +41,7 @@
   
 7. 每个 `*.gpt.md` 文件都会被解析成一个 AI 预设。

-### .gpt-runner 目录
+### 📂 .gpt-runner 目录

 1. `<rootPath>/.gpt-runner/` 目录是一个特殊目录，即便你把它包含在 `.gitignore` 里，它也会被检索。这对希望 GPT-Runner 不入侵项目的人很有用。

@@ -57,7 +57,7 @@ git config --global core.excludesfile '~/.gitignore_global'
 echo '.gpt-runner' >> ~/.gitignore_global
 ```

-## gptr.config.ts/js/json 配置文件
+## 📄 gptr.config.ts/js/json 配置文件

 1. gpt.config.ts/js/json 是一个配置文件，它可以覆盖项目级别全局配置。

@@ -183,7 +183,7 @@ export default defineConfig({
 }
 ```

-## xxx.gpt.md AI 预设文件
+## 📑 xxx.gpt.md AI 预设文件

 1. `xxx.gpt.md` 文件是一个 AI 预设文件，一个文件代表一个 AI 角色。

@@ -244,7 +244,7 @@ export default defineConfig({
 你还可以通过项目根目录下的 `gptr.config.json` 覆盖很多参数的默认值
 ````

-## 聊天模型配置
+## 🤖 聊天模型配置

 ### OpenAI 

@@ -321,7 +321,7 @@ export interface AnthropicModelConfig {
 }
 ```

-# 其他
+# 🔍 其他

 1. 如果你安装了 GPT Runner VSCode 扩展。你可以通过在 `.vscode/settings.json` 设置：

--- a/docs/gpt-config.en.md
+++ b/docs/gpt-config.en.md
@@ -1,21 +1,21 @@
-# GPT-Runner Configs And AI Preset Files
+# 📖 GPT-Runner Configs And AI Preset Files

 <details>
-<summary>Table of Contents</summary><br>
+<summary> 📚 Table of Contents</summary><br>

- [GPT-Runner Configs And AI Preset Files](#gpt-runner-configs-and-ai-preset-files)
-  - [Introduction](#introduction)
-    - [.gpt-runner Directory](#gpt-runner-directory)
-  - [gptr.config.ts/js/json Configuration Files](#gptrconfigtsjsjson-configuration-files)
-  - [xxx.gpt.md AI Preset Files](#xxxgptmd-ai-preset-files)
-  - [Chat Model Configuration](#chat-model-configuration)
+- [📖 GPT-Runner Configs And AI Preset Files](#-gpt-runner-configs-and-ai-preset-files)
+  - [✨ Introduction](#-introduction)
+    - [📂 .gpt-runner Directory](#-gpt-runner-directory)
+  - [📄 gptr.config.ts/js/json Configuration Files](#-gptrconfigtsjsjson-configuration-files)
+  - [📑 xxx.gpt.md AI Preset Files](#-xxxgptmd-ai-preset-files)
+  - [🤖 Chat Model Configuration](#-chat-model-configuration)
    - [OpenAI](#openai)
    - [Anthropic](#anthropic)
- [Other](#other)
+- [🔍 Other](#-other)

 <br></details>

-## Introduction
+## ✨ Introduction

 1. When you start GPT-Runner, it first reads the project-level configuration file.

@@ -41,7 +41,7 @@

 7. Each `*.gpt.md` file is parsed into an AI preset.

-### .gpt-runner Directory
+### 📂 .gpt-runner Directory

 1. `<rootPath>/.gpt-runner/` directory is a special directory. Even if you include it in `.gitignore`, it will be retrieved. This is useful for people who hope GPT-Runner doesn't intrude into the project.

@@ -57,7 +57,7 @@ git config --global core.excludesfile '~/.gitignore_global'
 echo '.gpt-runner' >> ~/.gitignore_global
 ```

-## gptr.config.ts/js/json Configuration Files
+## 📄 gptr.config.ts/js/json Configuration Files

 1. gpt.config.ts/js/json is a configuration file, it can override project-level global configurations.

@@ -183,7 +183,7 @@ export default defineConfig({
 }
 ```

-## xxx.gpt.md AI Preset Files
+## 📑 xxx.gpt.md AI Preset Files

 1. `xxx.gpt.md` files are AI preset files, each file represents an AI character.

@@ -246,7 +246,7 @@ You can write your remarks here.
 You can also override many default parameter values through the `gptr.config.json` at the root directory of the project.
 ````

-## Chat Model Configuration
+## 🤖 Chat Model Configuration

 ### OpenAI 

@@ -324,7 +324,7 @@ export interface AnthropicModelConfig {
 ```


-# Other
+# 🔍 Other

 1. If you have installed GPT Runner VSCode extension. You can set in `.vscode/settings.json`:

--- a/docs/ui-usage.cn.md
+++ b/docs/ui-usage.cn.md
@@ -1 +1 @@
-# GPT-Runner UI 使用说明
+# 📖 GPT-Runner UI 使用说明
--- a/docs/ui-usage.en.md
+++ b/docs/ui-usage.en.md
@@ -1 +1 @@
-# GPT-Runner UI Usage
+# 📖 GPT-Runner UI Usage
--- a/packages/gpt-runner-cli/README.md
+++ b/packages/gpt-runner-cli/README.md
@@ -1,47 +1,47 @@
 <div align="center">
 <img src="https://github.com/nicepkg/vr360/assets/35005637/102953c3-e804-46db-b0b3-acc26a8d37da" alt="icon"/>

-<h1 align="center">GPT-Runner CLI</h1>
+<h1 align="center">GPT-Runner CLI 🛠️</h1>

-English / [简体中文](https://github.com/nicepkg/gpt-runner/tree/main/packages/gpt-runner-cli/README_CN.md)
+English / [简体中文 🌏](https://github.com/nicepkg/gpt-runner/tree/main/packages/gpt-runner-cli/README_CN.md)

 [![npm](https://img.shields.io/npm/v/@nicepkg/gpt-runner-cli.svg)](https://www.npmjs.com/package/@nicepkg/gpt-runner-cli)
 [![CLI](https://img.shields.io/badge/CLI-Node.js-green?logo=node.js)](https://github.com/nicepkg/gpt-runner/tree/main/packages/gpt-runner-cli/)
 [![License](https://img.shields.io/github/license/nicepkg/gpt-runner)](https://github.com/nicepkg/gpt-runner/blob/main/LICENSE)
 ![GitHub stars](https://img.shields.io/github/stars/nicepkg/gpt-runner?style=social)

-The GPT-Runner CLI is a powerful command-line tool that helps you manage your AI presets and engage in AI-powered conversations with your code to significantly boost your development efficiency.
+The GPT-Runner CLI is a powerful command-line tool that helps you manage your AI presets and engage in AI-powered conversations with your code to significantly boost your development efficiency 💪.

-GPT-Runner CLI 是一款功能强大的命令行工具，可帮助您管理 AI 预设并与代码进行 AI 驱动的对话，从而显着提高您的开发效率。
+GPT-Runner CLI 是一款功能强大的命令行工具，可帮助您管理 AI 预设并与代码进行 AI 驱动的对话，从而显着提高您的开发效率 💪。

 </div>

 <details>
-<summary>Table of Contents</summary><br>
+<summary> 📚 Table of Contents</summary><br>

- [Features](#features)
- [Installation](#installation)
- [Quick Start](#quick-start)
- [CLI Commands](#cli-commands)
- [Documentation](#documentation)
+- [⚙️ Features](#️-features)
+- [📦 Installation](#-installation)
+- [🚀 Quick Start](#-quick-start)
+- [💡 CLI Commands](#-cli-commands)
+- [📖 Documentation](#-documentation)
  - [GPT-Runner Configs And AI Preset Files](#gpt-runner-configs-and-ai-preset-files)
  - [GPT-Runner Ui Usage](#gpt-runner-ui-usage)
- [FAQ](#faq)
- [Sponsor](#sponsor)
- [Contributor](#contributor)
- [License](#license)
+- [❓ FAQ](#-faq)
+- [💖 Sponsor](#-sponsor)
+- [🤝 Contributor](#-contributor)
+- [📜 License](#-license)

 <br></details>

-## Features
+## ⚙️ Features

- **Start GPT-Runner Server:** Quickly start a local development server for GPT-Runner with a simple command.
- **Customizable Server Port:** Specify the server port
- **Customizable Global Configuration:** Specify the path to the global configuration file of GPT-Runner.
- **Shareable Server Link:** Share the running server through a temporal link.
- **Debugging Support:** Run the server in debug mode to facilitate troubleshooting.
+- **⚡ Start GPT-Runner Server:** Quickly start a local development server for GPT-Runner with a simple command.
+- **🔧 Customizable Server Port:** Specify the server port
+- **🌍 Customizable Global Configuration:** Specify the path to the global configuration file of GPT-Runner.
+- **🔄 Shareable Server Link:** Share the running server through a temporal link.
+- **🐞 Debugging Support:** Run the server in debug mode to facilitate troubleshooting.

-## Installation
+## 📦 Installation


 > 1. Requirements NodeJS >= 16.15.0
@@ -63,7 +63,7 @@ gptr --version

 This command tells npm (Node.js package manager) to install GPT-Runner CLI globally. Among them, the `-g` option means global installation, which means you can run GPT-Runner CLI anywhere.

-## Quick Start
+## 🚀 Quick Start

 Go to your project folder and type the following command:

@@ -87,7 +87,7 @@ When you run gptr, it will retrieve the global config file [gptr.config.json](ht

 You can now see the GPT-Runner's web in your browser at [http://localhost:3003](http://localhost:3003).

-## CLI Commands
+## 💡 CLI Commands

 You can utilize the following options with GPT-Runner CLI:

@@ -110,7 +110,7 @@ gptr --port 8080 --config ./gptr.config.json --share --no-open --debug
 In this example, the GPT-Runner CLI will start a server available at port 8080, use the [gptr.config.json](https://github.com/nicepkg/gpt-runner/tree/main/docs/examples/gptr.config.json) configuration file, share the server link, not automatically open in the browser, and run in debug mode.


-## Documentation
+## 📖 Documentation

 ### GPT-Runner Configs And AI Preset Files

@@ -123,15 +123,15 @@ For details about `gptr.config.json` configuration file, `xxx.gpt.md` AI preset
 [Introduction to GPT-Runner Ui Usage](https://github.com/nicepkg/gpt-runner/blob/main/docs/ui-usage.en.md)

  
-## FAQ
+## ❓ FAQ

 [English > FAQ](https://github.com/nicepkg/gpt-runner/tree/main/docs/faq.en.md)

-## Sponsor
+## 💖 Sponsor

 Waiting for you...

-## Contributor
+## 🤝 Contributor

 You can check out our [Contribution Guidelines](https://github.com/nicepkg/gpt-runner/tree/main/CONTRIBUTING.md)

@@ -141,6 +141,6 @@ This project exists thanks to all the people who contribute:
  <img src="https://contrib.rocks/image?repo=nicepkg/gpt-runner" />
 </a>

-## License
+## 📜 License

 [MIT](https://github.com/nicepkg/gpt-runner/tree/main/LICENSE) License &copy; 2023-PRESENT [Jinming Yang](https://github.com/2214962083)
--- a/packages/gpt-runner-cli/README_CN.md
+++ b/packages/gpt-runner-cli/README_CN.md
@@ -1,45 +1,45 @@
 <div align="center">
 <img src="https://github.com/nicepkg/vr360/assets/35005637/102953c3-e804-46db-b0b3-acc26a8d37da" alt="icon"/>

-<h1 align="center">GPT-Runner CLI</h1>
+<h1 align="center">GPT-Runner CLI 🛠️</h1>

-[English](https://github.com/nicepkg/gpt-runner/tree/main/packages/gpt-runner-cli/README.md) / 简体中文
+[English 🌏](https://github.com/nicepkg/gpt-runner/tree/main/packages/gpt-runner-cli/README.md) / 简体中文

 [![npm](https://img.shields.io/npm/v/@nicepkg/gpt-runner-cli.svg)](https://www.npmjs.com/package/@nicepkg/gpt-runner-cli)
 [![CLI](https://img.shields.io/badge/CLI-Node.js-green?logo=node.js)](https://github.com/nicepkg/gpt-runner/tree/main/packages/gpt-runner-cli/)
 [![License](https://img.shields.io/github/license/nicepkg/gpt-runner)](https://github.com/nicepkg/gpt-runner/blob/main/LICENSE)
 ![GitHub stars](https://img.shields.io/github/stars/nicepkg/gpt-runner?style=social)

-GPT-Runner CLI 是一款功能强大的命令行工具，可帮助您管理 AI 预设并与代码进行 AI 驱动的对话，从而显着提高您的开发效率。
+GPT-Runner CLI 是一款功能强大的命令行工具，可帮助您管理 AI 预设并与代码进行 AI 驱动的对话，从而显着提高您的开发效率 💪。

 </div>

 <details>
-<summary>目录</summary><br>
+<summary> 📚 目录</summary><br>

- [特性](#特性)
- [安装](#安装)
- [快速开始](#快速开始)
- [CLI 命令](#cli-命令)
- [文档](#文档)
+- [⚙️ 特性](#️-特性)
+- [📦 安装](#-安装)
+- [🚀 快速开始](#-快速开始)
+- [💡 CLI 命令](#-cli-命令)
+- [📖 文档](#-文档)
  - [GPT-Runner 配置和 AI 预设文件](#gpt-runner-配置和-ai-预设文件)
  - [GPT-Runner Ui 用法](#gpt-runner-ui-用法)
- [常见问题](#常见问题)
- [赞助](#赞助)
- [贡献者](#贡献者)
- [许可证](#许可证)
+- [❓ 常见问题](#-常见问题)
+- [💖 赞助](#-赞助)
+- [🤝 贡献者](#-贡献者)
+- [📜 许可证](#-许可证)

 <br></details>

-## 特性
+## ⚙️ 特性

- **启动 GPT-Runner 服务器:** 使用一个简单的命令快速启动 GPT-Runner 的本地开发服务器。
- **可自定义服务器端口:** 指定服务器端口。
- **自定义全局配置:** 指定 GPT-Runner 的全局配置文件路径。
- **可共享的服务器链接:** 通过临时链接分享正在运行的服务器。
- **支持调试:** 在调试模式下运行服务器，方便故障排查。
+- **⚡ 启动 GPT-Runner 服务器:** 使用一个简单的命令快速启动 GPT-Runner 的本地开发服务器。
+- **🔧 可自定义服务器端口:** 指定服务器端口。
+- **🌍 自定义全局配置:** 指定 GPT-Runner 的全局配置文件路径。
+- **🔄 可共享的服务器链接:** 通过临时链接分享正在运行的服务器。
+- **🐞 支持调试:** 在调试模式下运行服务器，方便故障排查。

-## 安装
+## 📦 安装

 > 1. 要求 NodeJS >= 16.15.0
 >    - 要检查您的 NodeJS 版本，在终端运行 `node -v` 。如果需要安装或更新 NodeJS ，请访问[官方 NodeJS 网站](https://nodejs.org/)以获取下载和安装指南。
@@ -61,7 +61,7 @@ gptr --version

 此命令告诉 npm ( Node.js 包管理器) 全局安装 GPT-Runner CLI。其中，`-g` 选项表示全局安装，这意味着您可以在任何地方运行 GPT-Runner CLI。

-## 快速开始
+## 🚀 快速开始

 转到项目文件夹并输入以下命令:

@@ -85,7 +85,7 @@ gptr ./src

 现在，你可以在浏览器的 [http://localhost:3003](http://localhost:3003) 上看到 GPT-Runner 的 Web 界面。

-## CLI 命令
+## 💡 CLI 命令

 您可以使用以下选项与 GPT-Runner CLI 一起使用：

@@ -107,7 +107,7 @@ gptr --port 8080 --config ./gptr.config.json --share --no-open --debug

 在这个例子中，GPT-Runner CLI 将在端口 8080 上启动一个服务器，使用 [gptr.config.json](https://github.com/nicepkg/gpt-runner/tree/main/docs/examples/gptr.config.json) 的配置文件，分享服务器链接，不自动在浏览器中打开，并以调试模式运行。

-## 文档
+## 📖 文档

 ### GPT-Runner 配置和 AI 预设文件

@@ -119,15 +119,15 @@ gptr --port 8080 --config ./gptr.config.json --share --no-open --debug

 [GPT-Runner Ui使用介绍](https://github.com/nicepkg/gpt-runner/blob/main/docs/ui-usage.cn.md)

-## 常见问题
+## ❓ 常见问题

 [简体中文 > 常见问题](https://github.com/nicepkg/gpt-runner/tree/main/docs/faq.cn.md)

-## 赞助
+## 💖 赞助

 等待你的赞助...

-## 贡献者
+## 🤝 贡献者

 你可以查看我们的[贡献指南](https://github.com/nicepkg/gpt-runner/tree/main/CONTRIBUTING.md)

@@ -137,6 +137,6 @@ gptr --port 8080 --config ./gptr.config.json --share --no-open --debug
  <img src="https://contrib.rocks/image?repo=nicepkg/gpt-runner" />
 </a>

-## 许可证
+## 📜 许可证

 [MIT](https://github.com/nicepkg/gpt-runner/tree/main/LICENSE) 许可证 &copy; 2023-PRESENT [Jinming Yang](https://github.com/2214962083)
--- a/packages/gpt-runner-vscode/README.md
+++ b/packages/gpt-runner-vscode/README.md
@@ -1,9 +1,9 @@
 <div align="center">
 <img src="https://github.com/nicepkg/vr360/assets/35005637/102953c3-e804-46db-b0b3-acc26a8d37da" alt="icon"/>

-<h1 align="center">GPT-Runner VSCode</h1>
+<h1 align="center">GPT-Runner VSCode 🧑‍💻</h1>

-[简体中文](https://github.com/nicepkg/gpt-runner/tree/main/packages/gpt-runner-vscode/README_CN.md) / English
+[简体中文 🌏](https://github.com/nicepkg/gpt-runner/tree/main/packages/gpt-runner-vscode/README_CN.md) / English

 [![VSCode](https://img.shields.io/badge/VSCode-Extension-blue?logo=visualstudiocode)](https://marketplace.visualstudio.com/items?itemName=nicepkg.gpt-runner) [![License](https://img.shields.io/github/license/nicepkg/gpt-runner)](https://github.com/nicepkg/gpt-runner/blob/main/LICENSE)
 ![GitHub stars](https://img.shields.io/github/stars/nicepkg/gpt-runner?style=social)
@@ -15,35 +15,35 @@ This extension helps you manage AI presets and drive conversations with code usi
 </div>

 <details>
-<summary>Contents</summary><br>
+<summary> 📚 Table of Contents</summary><br>

- [Features](#features)
- [Installation](#installation)
- [Quick Start](#quick-start)
- [Documentation](#documentation)
+- [⚙️ Features](#️-features)
+- [📦 Installation](#-installation)
+- [🚀 Quick Start](#-quick-start)
+- [📖 Documentation](#-documentation)
  - [GPT-Runner Configs And AI Preset Files](#gpt-runner-configs-and-ai-preset-files)
  - [GPT-Runner Ui Usage](#gpt-runner-ui-usage)
- [Common Questions](#common-questions)
- [Sponsor](#sponsor)
- [Contributors](#contributors)
- [License](#license)
+- [❓ FAQ](#-faq)
+- [💖 Sponsor](#-sponsor)
+- [🤝 Contributors](#-contributors)
+- [📜 License](#-license)

 <br></details>

-## Features
+## ⚙️ Features

- **Real-time context:** It can observe the files you have edited and the text you have selected to answer your questions.
- **Multiple chat window instances:** You can not only open a chat in the sidebar, but you can also open a chat page in the editor.
- **Responsive UI:** It adjusts its layout automatically based on the current window width.
- **Shareable LAN links:** Click the `🚀 GPT-Runner` at the bottom to open it in the browser.
- **Conversation with code files:** Select files or folders to chat with AI in real-time.
- **Manage your AI presets:** Manage your AI presets, it's like the local Storybook for AI presets.
- **Custom AI Parameters:** Flexible control over the configuration of AI models.
- **Support for third-party LLMs:** High compatibility and adaptability.
- **Privacy-First:** Local data storage to protect your privacy.
- **Localization:** Support for multiple languages.
+- **📁 Real-time context:** It can observe the files you have edited and the text you have selected to answer your questions.
+- **🖥️ Multiple chat window instances:** You can not only open a chat in the sidebar, but you can also open a chat page in the editor.
+- **📱 Responsive UI:** It adjusts its layout automatically based on the current window width.
+- **🔗 Shareable LAN links:** Click the `🚀 GPT-Runner` at the bottom to open it in the browser.
+- **🔍 Conversation with code files:** Select files or folders to chat with AI in real-time.
+- **🔖 Manage your AI presets:** Manage your AI presets, it's like the local Storybook for AI presets.
+- **🤖 Custom AI Parameters:** Flexible control over the configuration of AI models.
+- **🔌 Support for third-party LLMs:** High compatibility and adaptability.
+- **🔒 Privacy-First:** Local data storage to protect your privacy.
+- **🌎 Localization:** Support for multiple languages.

-## Installation
+## 📦 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/account/api-keys) or [Anthropic](https://www.anthropic.com/product/) to apply.
@@ -52,7 +52,7 @@ You can search `GPT Runner` in the VSCode Extension Marketplace for installation

 Or, click here to install [GPT-Runner VSCode Extension](https://marketplace.visualstudio.com/items?itemName=nicepkg.gpt-runner).

-## Quick Start
+## 🚀 Quick Start

 1. Open a project and click on the chat icon on the sidebar.
 2. Click to confirm the initialization of the `.gpt.md` file.
@@ -63,7 +63,7 @@ Or, click here to install [GPT-Runner VSCode Extension](https://marketplace.visu
 > 1. Note the chat icon in the top right corner, which is also clickable
 > 2. Note the status bar at the bottom, `🚀 GPT-Runner` is also clickable

-## Documentation
+## 📖 Documentation

 ### GPT-Runner Configs And AI Preset Files

@@ -76,15 +76,15 @@ For details about `gptr.config.json` configuration file, `xxx.gpt.md` AI preset
 [Introduction to GPT-Runner Ui Usage](https://github.com/nicepkg/gpt-runner/blob/main/docs/ui-usage.en.md)


-## Common Questions
+## ❓ FAQ

-[English > Common Questions](https://github.com/nicepkg/gpt-runner/tree/main/docs/faq.en.md)
+[English > FAQ](https://github.com/nicepkg/gpt-runner/tree/main/docs/faq.en.md)

-## Sponsor
+## 💖 Sponsor

 Waiting for your sponsorship...

-## Contributors
+## 🤝 Contributors

 You can check out our [Contribution Guidelines](https://github.com/nicepkg/gpt-runner/tree/main/CONTRIBUTING.md)

@@ -94,6 +94,6 @@ This project exists thanks to all the people who contribute:
  <img src="https://contrib.rocks/image?repo=nicepkg/gpt-runner" />
 </a>

-## License
+## 📜 License

 [MIT](https://github.com/nicepkg/gpt-runner/tree/main/LICENSE) License &copy; 2023-PRESENT [Jinming Yang](https://github.com/2214962083)
--- a/packages/gpt-runner-vscode/README_CN.md
+++ b/packages/gpt-runner-vscode/README_CN.md
@@ -1,9 +1,9 @@
 <div align="center">
 <img src="https://github.com/nicepkg/vr360/assets/35005637/102953c3-e804-46db-b0b3-acc26a8d37da" alt="icon"/>

-<h1 align="center">GPT-Runner VSCode</h1>
+<h1 align="center">GPT-Runner VSCode 🧑‍💻</h1>

-[English](https://github.com/nicepkg/gpt-runner/tree/main/packages/gpt-runner-vscode/README.md) / 简体中文
+[English 🌏](https://github.com/nicepkg/gpt-runner/tree/main/packages/gpt-runner-vscode/README.md) / 简体中文


 [![VSCode](https://img.shields.io/badge/VSCode-Extension-blue?logo=visualstudiocode)](https://marketplace.visualstudio.com/items?itemName=nicepkg.gpt-runner) [![License](https://img.shields.io/github/license/nicepkg/gpt-runner)](https://github.com/nicepkg/gpt-runner/blob/main/LICENSE)
@@ -16,35 +16,35 @@ GPT-Runner VSCode 扩展是 GPT-Runner 跟 VSCode 深度结合的结果。
 </div>

 <details>
-<summary>目录</summary><br>
+<summary> 📚 目录</summary><br>

 - [特性](#特性)
- [安装](#安装)
- [快速开始](#快速开始)
- [文档](#文档)
+- [📦 安装](#-安装)
+- [🚀 快速开始](#-快速开始)
+- [📖 文档](#-文档)
  - [GPT-Runner 配置和 AI 预设文件](#gpt-runner-配置和-ai-预设文件)
  - [GPT-Runner Ui 用法](#gpt-runner-ui-用法)
- [常见问题](#常见问题)
- [赞助](#赞助)
- [贡献者](#贡献者)
- [许可证](#许可证)
+- [❓ 常见问题](#-常见问题)
+- [💖 赞助](#-赞助)
+- [🤝 贡献者](#-贡献者)
+- [📜 许可证](#-许可证)

 <br></details>

 ## 特性

- **实时上下文:** 它可以观察你已打开编辑的文件和你选中的文字回答你的问题。
- **多个聊天窗口实例:** 你不但可以在侧边栏打开聊天，还可以在编辑器里打开聊天页。
- **响应式 ui:** 它会根据当前窗口宽度自动调整自身布局。
- **可共享的局域网链接:** 点击底部 `🚀 GPT-Runner` 可以在浏览器打开。
- **与代码文件对话：** 选择文件或文件夹与 AI 实时对话。
- **管理你的 AI 预设：** 管理你的 AI 预设，它就像 AI 预设的本地 Storybook。
- **自定义 AI 参数：** 灵活控制 AI 模型的配置。
- **支持第三方 LLM：** 具有高度兼容性和适应性。
- **隐私优先：** 本地数据存储保护您的隐私。
- **国际化：** 支持多种语言。
+- **📁 实时上下文:** 它可以观察你已打开编辑的文件和你选中的文字回答你的问题。
+- **🖥️ 多个聊天窗口实例:** 你不但可以在侧边栏打开聊天，还可以在编辑器里打开聊天页。
+- **📱 响应式 ui:** 它会根据当前窗口宽度自动调整自身布局。
+- **🔗 可共享的局域网链接:** 点击底部 `🚀 GPT-Runner` 可以在浏览器打开。
+- **🔍 与代码文件对话：** 选择文件或文件夹与 AI 实时对话。
+- **🔖 管理你的 AI 预设：** 管理你的 AI 预设，它就像 AI 预设的本地 Storybook。
+- **🤖 自定义 AI 参数：** 灵活控制 AI 模型的配置。
+- **🔌 支持第三方 LLM：** 具有高度兼容性和适应性。
+- **🔒 隐私优先：** 本地数据存储保护您的隐私。
+- **🌎 国际化：** 支持多种语言。

-## 安装
+## 📦 安装

 > 1. 要求 VSCode >= 1.72.0
 > 2. 确保你有一个 Open AI Key 或 Anthropic Key，如果没有，请访问 [Open AI](https://platform.openai.com/account/api-keys) 或 [Anthropic](https://www.anthropic.com/product/) 申请。
@@ -54,7 +54,7 @@ GPT-Runner VSCode 扩展是 GPT-Runner 跟 VSCode 深度结合的结果。

 或者点击这里安装 [GPT-Runner VSCode 扩展](https://marketplace.visualstudio.com/items?itemName=nicepkg.gpt-runner)。

-## 快速开始
+## 🚀 快速开始

 1. 打开一个项目，点击侧边聊天 icon。
 2. 点击确认初始化 `.gpt.md` 文件。
@@ -65,7 +65,7 @@ GPT-Runner VSCode 扩展是 GPT-Runner 跟 VSCode 深度结合的结果。
 > 1. 注意你的右上角有个聊天 icon，那个也能点击
 > 2. 注意你的底部状态栏，有个 `🚀 GPT-Runner` 也能点击

-## 文档
+## 📖 文档

 ### GPT-Runner 配置和 AI 预设文件

@@ -77,15 +77,15 @@ GPT-Runner VSCode 扩展是 GPT-Runner 跟 VSCode 深度结合的结果。

 [GPT-Runner Ui使用介绍](https://github.com/nicepkg/gpt-runner/blob/main/docs/ui-usage.cn.md)

-## 常见问题
+## ❓ 常见问题

 [简体中文 > 常见问题](https://github.com/nicepkg/gpt-runner/tree/main/docs/faq.cn.md)

-## 赞助
+## 💖 赞助

 等待你的赞助...

-## 贡献者
+## 🤝 贡献者

 你可以查看我们的[贡献指南](https://github.com/nicepkg/gpt-runner/tree/main/CONTRIBUTING.md)

@@ -95,6 +95,6 @@ GPT-Runner VSCode 扩展是 GPT-Runner 跟 VSCode 深度结合的结果。
  <img src="https://contrib.rocks/image?repo=nicepkg/gpt-runner" />
 </a>

-## 许可证
+## 📜 许可证

 [MIT](https://github.com/nicepkg/gpt-runner/tree/main/LICENSE) 许可证 &copy; 2023-PRESENT [Jinming Yang](https://github.com/2214962083)