Update docs

This commit is contained in:
Him188 2020-12-24 17:02:33 +08:00
parent 25c5cc5e73
commit 4e778170ae
3 changed files with 24 additions and 12 deletions

View File

@ -21,7 +21,7 @@ import org.gradle.api.attributes.Attribute
*/
object Versions {
const val project = "2.0-M2-dev-1"
const val project = "2.0-M2-dev-2"
const val kotlinCompiler = "1.4.21"
const val kotlinStdlib = "1.4.21"

View File

@ -1,4 +1,4 @@
# Mirai - Creating Bots
# Mirai - Bots
**目录**

View File

@ -2,17 +2,11 @@
本文介绍如何在一个项目中使用 mirai。
mirai 使用纯 Kotlin 开发,最低要求 `JDK 1.8``Kotlin 1.4`。但注意不要使用 Oracle JDK推荐使用 OpenJDK。
mirai 使用纯 Kotlin 开发,兼容 JVM 平台语言如 Java最低要求 `JDK 1.8``Kotlin 1.4`。
**但注意不要使用 Oracle JDK**(会遇到打包后无法启动的问题),推荐使用 OpenJDK。
如果你熟悉 Gradle只需要添加 `jcenter` 仓库和依赖 `net.mamoe:mirai-core:VERSION` 即可而不需要继续阅读。下文将详细解释其他方法。
### 选择版本
本文提供如下三种配置方法,但更推荐使用 Gradle 构建。
- [A. 使用 Gradle](#a-使用-gradle)
- [B. 使用 Maven](#b-使用-maven)
- [C. 使用 IntelliJ](#c-使用-intellij)
### 选择版本
有关各类版本的区别,参考 [版本规范](Evolution.md#版本规范)
[Version]: https://api.bintray.com/packages/him188moe/mirai/mirai-core/images/download.svg?
@ -21,11 +15,23 @@ mirai 使用纯 Kotlin 开发,最低要求 `JDK 1.8``Kotlin 1.4`。但注
| 版本类型 | 版本号 |
|:------:|:------------------------------:|
| 稳定 | 1.3.3 |
| 预览 | 2.0-M2-dev-1 |
| 预览 | 2.0-M1-1 |
| 开发 | [![Version]][Bintray Download] |
即使 2.0 还没有稳定,也建议使用 2.0 预览版本,因 1.x 版本将不会收到任何更新。
### 配置项目
如果你熟悉 Gradle只需要添加 `jcenter` 仓库和依赖 `net.mamoe:mirai-core:VERSION` 即可而不需要继续阅读。下文将详细解释其他方法。
本文提供如下三种配置方法,但推荐使用 Gradle 构建。
- [A. 使用 Gradle](#a-使用-gradle)
- [B. 使用 Maven](#b-使用-maven)
- [C. 使用 IntelliJ](#c-使用-intellij)
- [D. 下载 JAR 包](#d-下载-jar-包)
## A. 使用 Gradle
### Gradle Kotlin DSL
@ -130,3 +136,9 @@ dependencies {
> [回到 Mirai 文档索引](README.md)
## D. 下载 JAR 包
非常不推荐这种方法,请尽可能使用构建工具。
在 [Jcenter](https://jcenter.bintray.com/net/mamoe/mirai-core-all/) 或 [阿里云代理仓库](https://maven.aliyun.com/repository/public/net/mamoe/mirai-core-all/) 下载指定版本的 `-all.jar` 文件,即包含 `mirai-core``mirai-core-api``mirai-core-utils` 和其他依赖。