docs: teach

This commit is contained in:
Neko Ayaka
2025-04-16 00:57:20 +08:00
parent 6c961cbb19
commit 5bef388867
3 changed files with 41 additions and 9 deletions
+7 -7
View File
@@ -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
+17 -1
View File
@@ -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))
+17 -1
View File
@@ -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) 驱动)