github-repos/mirai
1
0
Fork 0
mirror of https://github.com/mamoe/mirai.git synced 2025-01-27 17:00:14 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Him188 2021-03-18 09:38:34 +08:00
parent 1a85219b33
commit 8532837d78
2 changed files with 15 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -121,23 +121,22 @@ mirai 是一个在全平台下运行，提供 QQ Android 协议支持的高效
## 开始 ## 开始
- 开发文档: [docs](docs/README.md) - 开发文档: [docs](docs/README.md)
- 论坛: [Mirai Forum](https://mirai.mamoe.net/)
> *Mirai 只有唯一一个官方论坛 Mirai Forum*
- 更新日志: [release](https://github.com/mamoe/mirai/releases) - 更新日志: [release](https://github.com/mamoe/mirai/releases)
- 开发计划: [milestones](https://github.com/mamoe/mirai/milestones) - 开发计划: [milestones](https://github.com/mamoe/mirai/milestones)
- 讨论: [GitHub Discussions](https://github.com/mamoe/mirai/discussions) 和 [Gitter](https://gitter.im/mamoe/mirai?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) 以及 [MiraiForum](https://mirai.mamoe.net/) - 在线讨论: [Gitter](https://gitter.im/mamoe/mirai?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
> 在 GitHub Discussions 和 MiraiForum 提出的问题可能会收到 mirai 维护者的回复, 也欢迎分享你基于 mirai 的项目或想法.
>
> *除这三个途径外，Mirai 在各个平台均没有官方交流群或论坛*
- mirai 官方系列项目: [project-mirai](https://github.com/project-mirai) - mirai 开发组和官方系列项目: [project-mirai](https://github.com/project-mirai)
- mirai 社区相关项目: [awesome-mirai](https://github.com/project-mirai/awsome-mirai/blob/master/README.md) - mirai 社区相关项目 (旧): [awesome-mirai](https://github.com/project-mirai/awsome-mirai/blob/master/README.md)
- 帮助 mirai: [CONTRIBUTING](CONTRIBUTING.md) - 帮助 mirai: [CONTRIBUTING](CONTRIBUTING.md)
## 赞助 ## 赞助
- 本着与更多mirai开发者，用户，支持者共建更好的学习环境为目的，mamoe自2021年3月1日发起mirai官方社区的建设。社区建设可能涉及：学习论坛，插件中心，发布平台。由于社区的运维需要经费，mirai项目开启sponsor功能。 - 本着与更多 mirai 开发者、用户、支持者共建更好的学习环境为目的，mirai 自 2021 年 3 月 1 日发起官方社区的建设。社区建设可能涉及：[学习论坛](https://mirai.mamoe.net)、插件中心、发布平台。由于社区的运维需要经费，mirai 项目开启 sponsor 功能。
- 请注意，赞助是全自愿的，赞助者不会获得所谓“特权”，为资金管理方便，赞助后不设退款，折现等选项，最终解释权归社区运营团队所有。 - 请注意，赞助是全自愿的。赞助者不会获得特权，不赞助也可以使用全部的功能。为资金管理方便，赞助后不设退款、折现等选项。最终解释权归社区运营团队所有。
- 全部赞助金额，流向，票据单号等将全部<a href="https://github.com/project-mirai/mirai-sponsor/tree/main">透明化公示</a>，欢迎任何人随时查看及提出建议。 - 全部赞助金额、流向、票据单号等将<a href="https://github.com/project-mirai/mirai-sponsor/tree/main">透明化公示</a>，欢迎任何人随时查看及提出建议。
- 赞助支持实名/匿名，方式暂定仅支持支付宝。
## 鸣谢 ## 鸣谢

6
docs/README.md
View File

@ -69,16 +69,22 @@
**为了避免遇到各种问题，请仔细阅读。** **为了避免遇到各种问题，请仔细阅读。**
1. [JVM 环境和开发准备工作（2 分钟）](Preparations.md#mirai---preparations) 1. [JVM 环境和开发准备工作（2 分钟）](Preparations.md#mirai---preparations)
2. **配置项目依赖** （二选一） 2. **配置项目依赖** （二选一）
- 要把 mirai-core 嵌入一个应用使用，请阅读 [配置项目依赖](ConfiguringProjects.md)。 - 要把 mirai-core 嵌入一个应用使用，请阅读 [配置项目依赖](ConfiguringProjects.md)。
- 要为 [`mirai-console`] 框架开发插件，请阅读 [mirai-console 的配置插件项目](https://github.com/mamoe/mirai-console/blob/master/docs/ConfiguringProjects.md)。 - 要为 [`mirai-console`] 框架开发插件，请阅读 [mirai-console 的配置插件项目](https://github.com/mamoe/mirai-console/blob/master/docs/ConfiguringProjects.md)。
3. 阅读 API 文档（见下文） 3. 阅读 API 文档（见下文）
> 如果你不知道 `mirai-core` 或 [`mirai-console`] 是什么，请阅读 [Mirai 生态概览](mirai-ecology.md)。 > 如果你不知道 `mirai-core` 或 [`mirai-console`] 是什么，请阅读 [Mirai 生态概览](mirai-ecology.md)。
> >
> 如果你希望先确认 mirai 能够正常运行才能安心阅读文档，可克隆 [mirai-hello-world](https://github.com/project-mirai/mirai-hello-world) 并运行其中 Kotlin 或 Java 入口点 `main`。 > 如果你希望先确认 mirai 能够正常运行才能安心阅读文档，可克隆 [mirai-hello-world](https://github.com/project-mirai/mirai-hello-world) 并运行其中 Kotlin 或 Java 入口点 `main`。
之后...
- [让更多人看到你的项目 - 在论坛发布](https://mirai.mamoe.net/category/6/%E9%A1%B9%E7%9B%AE%E5%8F%91%E5%B8%83)
### mirai-core API 文档 ### mirai-core API 文档
> *适用于 2.x 版本* > *适用于 2.x 版本*