上线Miao-Yunzai使用文档

README.md

@@ -8,11 +8,17 @@
 
 ## 使用方法
 
-> 运行环境： Windows or Linux，Node.js（ [版本至少v16.14.0以上](http://nodejs.cn/download/) ）， [Redis](https://redis.io/docs/getting-started/installation/ )
+[！点击阅读Miao-Yunzai文档了解更多](https://ningmengchongshui.github.io/Miao-Yunzai-Docs/)
 
-> Node.js 版本请积极使用nvm进行管理
+> 必要环境 Windows/Linux + Chrome/Chromium/Edge
 
-1.克隆项目并安装miao-plugin
+> 必要环境 Node.js>16.14.0 + Redis>5.0.0
+
+> 推荐环境 Node.js=18.18.2 + Redis>6.0.0
+
+> 推荐使用NVM对Node.js进行版本管理
+
+### 克隆项目
 
 > 请根据网络情况选择Github安装或Gitee安装
 
@@ -30,86 +36,42 @@ cd Miao-Yunzai
 git clone --depth=1 https://gitee.com/yoimiya-kokomi/miao-plugin.git ./plugins/miao-plugin/
 ```
 
-2.安装[pnpm](https://pnpm.io/zh/installation) ，已安装的可以跳过
+### 安装[pnpm](https://pnpm.io/zh/installation)
+
+> 已安装的可以跳过
 
 ```sh
 npm install pnpm -g
 ```
 
-3.安装依赖
-> 外网环境请注释修改.npmrc的本地npm配置
+###  安装依赖
+
+> 外网环境请修改的本地npm配置.npmrc
+
 ```sh
 # 直接安装
 pnpm install -P
 ```
 
-4.运行（首次运行按提示输入登录）
+### 运行
+
+> 首次运行按提示输入登录
 
 ```sh
-node app
+npm run app
 ```
 
-## 常见问题
-
-<details><summary>展开/收起</summary>
-
-### 无头浏览器相关
-
-linux环境，其他环境请自行探索
+### 登录
 
 ```sh
-puppeteer Chromium 启动中...
-    Error: Failed to launch the browser process!
+npm run login
 ```
 
-### 依赖库
+### 托管
 
 ```sh
-yum install pango.x86_64 libXcomposite.x86_64 libXcursor.x86_64 libXdamage.x86_64 libXext.x86_64 libXi.x86_64 libXtst.x86_64 cups-libs.x86_64 libXScrnSaver.x86_64 libXrandr.x86_64 GConf2.x86_64 alsa-lib.x86_64 atk.x86_64 gtk3.x86_64 -y
+npm run start
 ```
-
-### 乱码字体
-
-```sh
-yum groupinstall fonts -y
-```
-
-### centos7 监听事件错误 "CXXABI_1.3.8" not found 解决办法
-
-下载 [libstdc++.so.6.0.29.zip](https://baiyin1314.lanzouq.com/i8Nr21ig8hyf) 将 **解压缩后** 的文件放在/usr/lib64/中
-
-```sh
-cd /usr/lib64/
-sudo mv libstdc++.so.6 libstdc++.so.6.bak
-sudo ln -s libstdc++.so.6.0.29 libstdc++.so.6
-```
-
-</details>
-
-## 与原版Yunzai-Bot的差异
-
-**【注意】：** 由于是独立新的仓库，【只建议新部署/部署后迁移】，不建议原Bot直接换源强更
-
-* **一些新特性：** Miao-Yunzai会逐步重构，增加新特性与功能，可能会有功能与形态上的变化。如期望功能更加稳定可使用此仓库[Yunzai-V3](https://gitee.com/yoimiya-kokomi/Yunzai-Bot)
-* **移除了签到功能：** 与原Yunzai独立的仓库，去除了较为敏感的签到功能，以尝试恢复[Github](https://github.com/yoimiya-kokomi/Miao-Yunzai.git)
-  环境。附加[Gitee](https://gitee.com/yoimiya-kokomi/Miao-Yunzai.git)
-* **默认启用喵版的功能：** 【#角色】【#深渊】【#帮助】等功能默认启用喵版，原版的逻辑会屏蔽，以便于后续逐步精简资源
-* **一键迁移 TRSS-Yunzai：** 若无法登录QQ，可尝试 `node trss` 迁移，迁移后可登录其他协议端 [TRSS-Yunzai](https://gitee.com/TimeRainStarSky/Yunzai)
-
-## Miao-Yunzai 的修改
-
-[√] 角色卡片、抽卡分析等使用`miao-plugin`版本
-
-[√] 星铁底层支持，原神&星铁多UID支持
-
-项目仅供学习交流使用，严禁用于任何商业用途和非法行为
-
-## 开发者
-
-如果你是机器人插件生态开发的参与者，你可能需要阅读dev分支。
-
-它有助于你了解数据类型和未来将要发展的版本。
-
 ## 致谢
 
 |                           Nickname                            | Contribution     |