github-repos/mirai
1
0
Fork 0
mirror of https://github.com/mamoe/mirai.git synced 2024-12-27 09:00:15 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Him188 2021-01-11 21:21:15 +08:00
parent 55688f3193
commit 0c527af303
1 changed files with 8 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/Preparations.md
View File

@ -1,8 +1,6 @@
# Mirai - Preparations
***此文档假设你是 JVM 平台的开发者。若不是，请参考 [其他语言 SDK](README.md#确定-sdk)***
本章节介绍 Mirai 的环境和开发要求。预计阅读时间 2 分钟。
本章节介绍 Mirai 的 JVM 环境和开发准备工作。预计阅读时间 2 分钟。
## JVM 环境要求
@ -12,9 +10,9 @@
**但注意不要使用 Oracle JDK**（[原因](https://github.com/mamoe/mirai/discussions/779)），可以使用其他任何 JDK。
> 实用链接：
> [AdoptOpenJDK 下载](https://adoptopenjdk.net/)
> 如果你使用 IntelliJ IDEA，可以在 `Project Structure`(`Ctrl+Shift+Alt+S`) -> `SDKs` -> `+` -> `Download JDK` 下载 JDK。
> 下载 JDK：
> - 手动下载安装如 [AdoptOpenJDK](https://adoptopenjdk.net/)
> - 自动在 IntelliJ IDEA `Project Structure`(`Ctrl+Shift+Alt+S`) -> `SDKs` -> `+` -> `Download JDK` 下载安装
## 开发的准备工作
@ -25,10 +23,9 @@
- [Kotlin Jvm Blocking Bridge](https://github.com/mamoe/kotlin-jvm-blocking-bridge) ([查看 JetBrains 插件仓库](https://plugins.jetbrains.com/plugin/14816-kotlin-jvm-blocking-bridge) / [点击一键安装](https://plugins.jetbrains.com/embeddable/install/14816))：**帮助 Java 用户调用 Kotlin suspend 函数**
- [Mirai Console IntelliJ](https://github.com/mamoe/mirai-console/tree/master/tools/intellij-plugin) ([查看 JetBrains 插件仓库](https://plugins.jetbrains.com/plugin/15094-mirai-console) / [点击一键安装](https://plugins.jetbrains.com/embeddable/install/15094))：提供 mirai-core 的错误检查和 mirai-console 的插件开发辅助
使用 Kotlin 开发也可以不安装插件。
如果使用 Kotlin 开发，可以不安装插件。但非常推荐安装 Mirai Console IntelliJ 以获得一些错误检查功能。
如果使用 Java 或其他语言，请务必安装 Kotlin Jvm Blocking Bridge，否则会无法使用（[为什么？](KotlinAndJava.md#协程)）。同时请确保 Kotlin 插件是最新版本（在 `Settings -> Plugins` 启用并更新 Kotlin 到最新）。
使用 Java 或其他语言，请务必安装 Kotlin Jvm Blocking Bridge（[为什么？](KotlinAndJava.md#协程)）。同时请确保 Kotlin 插件是最新版本（在 `Settings -> Plugins` 启用并更新 Kotlin 到最新）。
*如果你不知道这俩是什么，都安装就对了。*
@ -36,6 +33,6 @@
Kotlin 是[让开发人员更快乐的一门现代编程语言](https://www.kotlincn.net/)，由 [IntelliJ IDEA](https://www.jetbrains.com/idea/) 的开发公司 [JetBrains](https://www.jetbrains.com/) 维护，被 Google 推举为 Android 首选编程语言。
使用 Mirai 是一个不错的学习 Kotlin 机会，使用者可以在 [官方中文文档](https://www.kotlincn.net/docs/reference/) 学习 Kotlin。
使用 Mirai 是一个不错的学习 Kotlin 机会，使用者有兴趣可以在 [官方中文文档](https://www.kotlincn.net/docs/reference/) 学习 Kotlin。
Java 开发者如果只希望使用 Mirai 而不学习 Kotlin，可以阅读 [KotlinAndJava.md](KotlinAndJava.md)（5 分钟）。
Java 开发者如果只希望使用 Mirai 而不学习 Kotlin，也请阅读 [Kotlin 定义对应的 Java 定义](KotlinAndJava.md)（5 分钟）。