From 5bef388867ea7c1cedd27733d1f57557cef2b3cd Mon Sep 17 00:00:00 2001 From: Neko Ayaka Date: Wed, 16 Apr 2025 00:57:20 +0800 Subject: [PATCH] docs: teach --- CONTRIBUTING.md | 14 +++++++------- README.md | 18 +++++++++++++++++- README.zh-CN.md | 18 +++++++++++++++++- 3 files changed, 41 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 78b5afb2a..1047c3bdb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -135,7 +135,7 @@ pnpm install ### Documentation site ```shell -pnpm -F @proj-airi/docs... --parallel dev +pnpm -F @proj-airi/docs dev ``` > [!NOTE] @@ -143,13 +143,13 @@ pnpm -F @proj-airi/docs... --parallel dev > For [@antfu/ni](https://github.com/antfu-collective/ni) users, you can > > ```shell -> nr -F @proj-airi/docs... --parallel dev +> nr -F @proj-airi/docs dev > ``` ### Stage web (Frontend for [airi.moeru.ai](https://airi.moeru.ai), or [airi.ayaka.io](https://airi.ayaka.io)) ```shell -pnpm -F @proj-airi/stage-web... --parallel dev +pnpm -F @proj-airi/stage-web dev ``` > [!NOTE] @@ -157,13 +157,13 @@ pnpm -F @proj-airi/stage-web... --parallel dev > For [@antfu/ni](https://github.com/antfu-collective/ni) users, you can > > ```shell -> nr -F @proj-airi/stage-web... --parallel dev +> nr -F @proj-airi/stage-web dev > ``` ### Stage Tamagotchi (Electron app for アイリ VTuber) ```shell -pnpm -F @proj-airi/stage-tamagotchi... --parallel dev +pnpm -F @proj-airi/stage-tamagotchi dev ``` > [!NOTE] @@ -171,7 +171,7 @@ pnpm -F @proj-airi/stage-tamagotchi... --parallel dev > For [@antfu/ni](https://github.com/antfu-collective/ni) users, you can > > ```shell -> nr -F @proj-airi/stage-tamagotchi... --parallel dev +> nr -F @proj-airi/stage-tamagotchi dev > ``` ### Telegram bot integration @@ -215,7 +215,7 @@ pnpm -F @proj-airi/telegram-bot start > For [@antfu/ni](https://github.com/antfu-collective/ni) users, you can > > ```shell -> nr -F @proj-airi/telegram-bot... --parallel dev +> nr -F @proj-airi/telegram-bot dev > ``` ### Discord bot integration diff --git a/README.md b/README.md index 29562b1c2..a2abebb4d 100644 --- a/README.md +++ b/README.md @@ -90,12 +90,28 @@ Capable of ## Development +> For detailed instructions to develop this project, follow the [CONTRIBUTING.md](./CONTRIBUTING.md) + ```shell pnpm i ``` +### Documentation site + ```shell -pnpm dev +pnpm -F @proj-airi/docs dev +``` + +### Stage web (Frontend for [airi.moeru.ai](https://airi.moeru.ai), or [airi.ayaka.io](https://airi.ayaka.io)) + +```shell +pnpm -F @proj-airi/stage-web dev +``` + +### Stage Tamagotchi (Electron app for アイリ VTuber) + +```shell +pnpm -F @proj-airi/stage-tamagotchi dev ``` ## Supported the following LLM API Providers (powered by [xsai](https://github.com/moeru-ai/xsai)) diff --git a/README.zh-CN.md b/README.zh-CN.md index 8c0b97665..209f72cc0 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -88,12 +88,28 @@ ## 开发 +> 有关开发此项目的具体教程,参见 [CONTRIBUTING.md](./CONTRIBUTING.md) + ```shell pnpm i ``` +### 文档站 + ```shell -pnpm dev +pnpm -F @proj-airi/docs dev +``` + +### 网页端舞台 ([airi.moeru.ai](https://airi.moeru.ai) 的前端页面) + +```shell +pnpm -F @proj-airi/stage-web dev +``` + +### 拓麻歌子端舞台 (Electron 桌面 App) + +```shell +pnpm -F @proj-airi/stage-tamagotchi dev ``` ## 原生支持的 LLM API 提供商列表(由 [xsai](https://github.com/moeru-ai/xsai) 驱动)