From fe649726f3b8cf9a2ab8cd576197f6628666d5af Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E7=B1=B3=E5=8F=AF=E7=BB=AB=E5=A4=8F?= <77883323+MikkoAyaka@users.noreply.github.com> Date: Tue, 21 Mar 2023 22:57:36 +0800 Subject: [PATCH] =?UTF-8?q?[docs]=20=E5=AE=8C=E5=96=84=E4=BA=86=E7=94=A8?= =?UTF-8?q?=E6=88=B7=E6=96=87=E6=A1=A3=E9=83=A8=E5=88=86=E7=9A=84=E5=86=85?= =?UTF-8?q?=E5=AE=B9=20(#2541)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * 对 README 做了一丢丢改动 把用户和开发者部分的索引分开以便用户区分 调整了一点点细节 * 完善用户手册 补充了简单易懂的安装教程 * 规范 README 文档语法 * Apply suggestions from code review Co-authored-by: Yurinann <1713574450@qq.com> Co-authored-by: Him188 <Him188@mamoe.net> * 规范了用户手册的文档内容 * 订正了一个空格错误 * 订正一个语法错误 * Update docs/UserManual.md --------- Co-authored-by: Yurinann <1713574450@qq.com> Co-authored-by: Him188 <Him188@mamoe.net> --- README.md | 17 +++++++++++------ docs/UserManual.md | 34 +++++++++++++++++++++++++++++----- 2 files changed, 40 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 1c48b7a6b..99e066370 100644 --- a/README.md +++ b/README.md @@ -113,18 +113,23 @@ mirai 是一个在全平台下运行，提供 QQ Android 协议支持的高效 **一切开发旨在学习，请勿用于非法用途** -## 开始 +## 快速使用 - **用户手册**: [UserManual](docs/UserManual.md) + + > 如果你希望快速部署一个 Mirai QQ 机器人，安装插件、并投入使用，请看这里 +- 论坛: [Mirai Forum](https://mirai.mamoe.net/) + + > Mirai 只有**唯一一个**官方论坛 Mirai Forum +- 在线讨论: [Gitter](https://gitter.im/mamoe/mirai?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) + +## 开发相关 + - 开发文档: [在 GitHub 阅读](docs/README.md) 或 [在 docs.mirai.mamoe.net 阅读](https://docs.mirai.mamoe.net/) -- 帮助 mirai: [CONTRIBUTING](docs/contributing/README.md) -- 论坛: [Mirai Forum](https://mirai.mamoe.net/) - > *Mirai 只有唯一一个官方论坛 Mirai Forum* - +- 参与贡献: [CONTRIBUTING](docs/contributing/README.md) - 更新日志: [release](https://github.com/mamoe/mirai/releases) - 开发计划: [milestones](https://github.com/mamoe/mirai/milestones) -- 在线讨论: [Gitter](https://gitter.im/mamoe/mirai?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) - mirai 开发组和官方系列项目: [project-mirai](https://github.com/project-mirai) - mirai 社区相关项目 ( diff --git a/docs/UserManual.md b/docs/UserManual.md index 344241a80..bbcbba2e3 100644 --- a/docs/UserManual.md +++ b/docs/UserManual.md @@ -1,12 +1,14 @@ # Mirai - UserManual -Mirai 用户手册。本文面向对开发不熟悉而希望使用 Mirai 的用户。如果你要开发，请先阅读 [开发文档](README.md)。 +这里是 Mirai 用户手册。本文面向对开发并不熟悉，但希望使用 Mirai 提供的 QQ 机器人服务支持的用户。 +如果你要开发 Mirai 插件或参与贡献 Mirai 项目，请先阅读 [开发文档](README.md)。 ## 启动 Mirai -使用 Mirai，一般人要启动的是 Mirai 控制台（即 Mirai Console），它可以加载插件。 +想要部署并使用 Mirai QQ机器人框架，只需要启动 Mirai 控制台（即 Mirai Console）， +它自带一些基础功能，也可以加载社区提供的插件。 -Mirai 控制台现在有两个版本，插件在这两个版本的 Mirai Console 上都可以运行: +Mirai 控制台现在有两个版本，Mirai 插件在这两个版本的 Mirai Console 上都可以运行: [MCLI-1.png]: .UserManual_images/MCLI-1.png @@ -20,11 +22,33 @@ Mirai 控制台现在有两个版本，插件在这两个版本的 Mirai Console ## 使用图形界面版本 前往 [sonder-joker/mirai-compose](https://github.com/sonder-joker/mirai-compose/releases) -下载适合你的系统的压缩包，解压到一个文件就可以使用。 +下载适合你的系统的压缩包， +> MAC 系统下载 .dmg 后缀的文件 +> Windows 系统下载 .msi 后缀的文件 +> Linux 系统下载 .deb 后缀的文件 + +以 Windows 系统为例，以下为简要安装步骤： + +1. 下载 `mirai-compose-<版本>.msi` +2. 双击运行安装程序，选择一个合适的文件夹，然后点击安装 +3. 安装完毕后打开刚才指定的文件夹 +4. 双击启动其中的 `mirai-compose.exe` 即可开始运行 +5. 运行后点击左上角可以添加 QQ bot 账号 + +安装插件只需要将下载好的插件置于 plugins 目录，安装完毕后重启 mirai-compose 以生效。 ## 使用纯控制台版本 -查看 [ConsoleTerminal.md](ConsoleTerminal.md)。 +详细教程请查看 [ConsoleTerminal.md](ConsoleTerminal.md)。 + +以 Windows 系统为例，以下为简要安装步骤： + +1. 前往 [iTXTech/mcl-installer](https://github.com/iTXTech/mcl-installer/releases) 下载适合您系统的最新版本的 MCL 安装器 +2. 创建好文件夹之后，将 MCL 安装器移动到其中 +3. 双击 `mcl-installer.exe` 过程中只需要按几次回车键，即可安装完毕 +4. 运行 `mcl.cmd` 即可启动 MCL 控制台 + +安装插件只需要将下载好的插件置于 plugins 目录，然后重启 MCL 控制台即可。 ## 解决问题