github-repos/mirai
1
0
Fork 0
mirror of https://github.com/mamoe/mirai.git synced 2025-02-05 16:07:00 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Him188 2021-01-24 15:59:54 +08:00
parent 413b703dc6
commit 708e77bcfa
2 changed files with 41 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
docs/README.md
View File

@ -6,7 +6,7 @@
**[Mirai 生态概览](mirai-ecology.md)** **[Mirai 生态概览](mirai-ecology.md)**
## 确定 SDK ## 社区 SDK
**mirai 官方提供 Kotlin/Java 等 JVM 平台语言开发支持。如果不熟悉这些语言，请使用以下社区 SDK：** **mirai 官方提供 Kotlin/Java 等 JVM 平台语言开发支持。如果不熟悉这些语言，请使用以下社区 SDK：**
@ -17,6 +17,7 @@
[mamoe/mirai-api-http]: https://github.com/mamoe/mirai-api-http [mamoe/mirai-api-http]: https://github.com/mamoe/mirai-api-http
[iTXTech/mirai-native]: https://github.com/iTXTech/mirai-native [iTXTech/mirai-native]: https://github.com/iTXTech/mirai-native
[iTXTech/mirai-js]: https://github.com/iTXTech/mirai-js [iTXTech/mirai-js]: https://github.com/iTXTech/mirai-js
[iTXTech/mirai-kts]: https://github.com/iTXTech/mirai-kts
[GraiaProject/Application]: https://github.com/GraiaProject/Application [GraiaProject/Application]: https://github.com/GraiaProject/Application
[RedBeanN/node-mirai]: https://github.com/RedBeanN/node-mirai [RedBeanN/node-mirai]: https://github.com/RedBeanN/node-mirai
[Logiase/gomirai]: https://github.com/Logiase/gomirai [Logiase/gomirai]: https://github.com/Logiase/gomirai
@ -34,24 +35,25 @@
[Rhino]: https://github.com/mozilla/rhino [Rhino]: https://github.com/mozilla/rhino
[OneBot]: https://github.com/howmanybots/onebot [OneBot]: https://github.com/howmanybots/onebot
| 技术 | 实现 | 维护者及项目地址 | | 技术 | 实现 | 维护者及项目地址 |
|:-----------------|:--------------------------|:--------------------------------------------| |:-------------------|:--------------------------|:--------------------------------------------|
| ***Mirai Http*** | Mirai 标准 | [mamoe/mirai-api-http] | | ***Mirai Http*** | Mirai 标准 | [mamoe/mirai-api-http] |
| *OneBot Http* | [OneBot] 标准 | [yyuueexxiinngg/onebot-kotlin] | | *OneBot Http* | [OneBot] 标准 | [yyuueexxiinngg/onebot-kotlin] |
| `Python` | *Mirai Http* | [Graia Framework][GraiaProject/Application] | | `C++` | JNI | [Nambers/MiraiCP] |
| `C++` | *Mirai Http* | [cyanray/mirai-cpp] | | `Kotlin Scripting` | JVM | [iTXTech/mirai-kts] |
| `C++` | *Mirai Http* | [Chlorie/miraipp] | | `Python` | *Mirai Http* | [Graia Framework][GraiaProject/Application] |
| `C++` | JNI | [Nambers/MiraiCP] | | `C++` | *Mirai Http* | [cyanray/mirai-cpp] |
| `C#` | *Mirai Http* | [Executor-Cheng/mirai-CSharp] | | `C++` | *Mirai Http* | [Chlorie/miraipp] |
| `Rust` | *Mirai Http* | [HoshinoTented/mirai-rs] | | `C#` | *Mirai Http* | [Executor-Cheng/mirai-CSharp] |
| `JavaScript` | [Rhino] / JVM | [iTXTech/mirai-js] | | `Rust` | *Mirai Http* | [HoshinoTented/mirai-rs] |
| `JavaScript` | Node.js / *Mirai Http* | [RedBeanN/node-mirai] | | `JavaScript` | [Rhino] / JVM | [iTXTech/mirai-js] |
| `JavaScript` | TypeScript / *Mirai Http* | [YunYouJun/mirai-ts] | | `JavaScript` | Node.js / *Mirai Http* | [RedBeanN/node-mirai] |
| `JavaScript` | [Rhino] / JVM | [StageGuard/mirai-rhinojs-sdk] | | `JavaScript` | TypeScript / *Mirai Http* | [YunYouJun/mirai-ts] |
| `.Net/C#` | *Mirai Http* | [Hyperai][theGravityLab/ProjHyperai] | | `JavaScript` | [Rhino] / JVM | [StageGuard/mirai-rhinojs-sdk] |
| `Go` | *Mirai Http* | [Logiase/gomirai] | | `.Net/C#` | *Mirai Http* | [Hyperai][theGravityLab/ProjHyperai] |
| `易语言` | *Mirai Http* | [only52607/e-mirai] | | `Go` | *Mirai Http* | [Logiase/gomirai] |
| *酷 Q DLL 插件* | JNI | [iTXTech/mirai-native] | | `易语言` | *Mirai Http* | [only52607/e-mirai] |
| *酷 Q DLL 插件* | JNI | [iTXTech/mirai-native] |
> *想在这里添加你的项目？欢迎[提交 PR](https://github.com/mamoe/mirai/edit/dev/docs/README.md)。* > *想在这里添加你的项目？欢迎[提交 PR](https://github.com/mamoe/mirai/edit/dev/docs/README.md)。*
@ -61,7 +63,7 @@
## JVM 平台 Mirai 开发 ## JVM 平台 Mirai 开发
**Mirai 文档没有废话，请务必仔细阅读每一个字。仔细阅读文档花费的 1 分钟可能相当于不阅读文档而自己摸索解决办法的 1 小时。** **为了避免遇到各种问题，请仔细阅读。**
1. [JVM 环境和开发准备工作（2 分钟）](Preparations.md#mirai---preparations) 1. [JVM 环境和开发准备工作（2 分钟）](Preparations.md#mirai---preparations)
2. **配置项目依赖** 2. **配置项目依赖**
@ -69,7 +71,7 @@
- 要为 [`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-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`。

42
docs/mirai-ecology.md
View File

File diff suppressed because one or more lines are too long