Merge pull request #183 from lengthmin/update-docs

Update guides

docs/guide_getting_started.md

@@ -1,6 +1,6 @@
 # Mirai Guide - Getting Started
 
-由于Mirai项目在快速推进中，因此内容时有变动，本文档的最后更新日期为```2020-02-29```，对应版本```0.23.0```
+由于Mirai项目在快速推进中，因此内容时有变动，本文档的最后更新日期为```2020-04-01```，对应版本```0.31.4```
 
 假如仅仅使用Mirai，不需要对整个项目进行Clone，只需在项目内添加Gradle Dependency或使用即可。
 
@@ -17,7 +17,8 @@
 
 ### 1 安装IDEA与JDK
 
-JDK要求6以上
+- JDK 要求6以上
+- IDEA 内设置 kotlin 插件为 EAP 版本，参考[本文](https://kotlinlang.org/eap/install-eap-plugin.html)
 
 ### 2 新建Gradle项目
 
@@ -39,12 +40,14 @@ JDK要求6以上
   //添加jcenter仓库
   /*
   repositories {
+      maven { url 'https://dl.bintray.com/kotlin/kotlin-eap' }
       mavenCentral()
   }
   原文内容，更新为下文
   */
   
   repositories {
+      maven { url 'https://dl.bintray.com/kotlin/kotlin-eap' }
       mavenCentral()
       jcenter()
   }
@@ -54,7 +57,7 @@ JDK要求6以上
 
   ```groovy
   dependencies {
-      implementation 'net.mamoe:mirai-core-qqandroid-jvm:0.23.0'//此处版本应替换为当前最新
+      implementation 'net.mamoe:mirai-core-qqandroid-jvm:0.31.4'//此处版本应替换为当前最新
       implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8"
       testCompile group: 'junit', name: 'junit', version: '4.12'
   }

docs/guide_subscribe_events.md

@@ -1,6 +1,6 @@
 # Mirai Guide - Subscribe Events
 
-由于Mirai项目在快速推进中，因此内容时有变动，本文档的最后更新日期为```2020-02-29```，对应版本```0.23.0```
+由于Mirai项目在快速推进中，因此内容时有变动，本文档的最后更新日期为`2020-04-01`，对应版本`0.31.4`
 
 本页面采用Kotlin作为开发语言，**若你希望使用 Java 开发**, 请参阅: [mirai-japt](https://github.com/mamoe/mirai-japt)
 
@@ -29,31 +29,27 @@ suspend fun main() {
 }
 ```
 
-在本例中，```miraiBot```是一个Bot对象，让其登录，然后对```Message Event```进行了监听。
+在本例中，`miraiBot`是一个Bot对象，让其登录，然后对`Message Event`进行了监听。
-
-对于``````Message Event``````，```Mirai```提供了较其他Event更强大的[MessageSubscribersBuilder](https://github.com/mamoe/mirai/wiki/mirai-core/src/commonMain/kotlin/net.mamoe.mirai/event/MessageSubscribers.kt#L140)，本例也采用了[MessageSubscribersBuilder](https://github.com/mamoe/mirai/wiki/mirai-core/src/commonMain/kotlin/net.mamoe.mirai/event/MessageSubscribers.kt#L140)。其他具体使用方法可以参考[Wiki:Message Event](https://github.com/mamoe/mirai/wiki/Development-Guide---Kotlin#Message-Event)部分。
-
 
+对于`Message Event`，`Mirai`提供了较其他Event更强大的[MessageSubscribersBuilder](https://github.com/mamoe/mirai/wiki/mirai-core/src/commonMain/kotlin/net.mamoe.mirai/event/MessageSubscribers.kt#L140)，本例也采用了[MessageSubscribersBuilder](https://github.com/mamoe/mirai/wiki/mirai-core/src/commonMain/kotlin/net.mamoe.mirai/event/MessageSubscribers.kt#L140)。其他具体使用方法可以参考[Wiki:Message Event](https://github.com/mamoe/mirai/wiki/Development-Guide---Kotlin#Message-Event)部分。
 
 ## 事件-Event
 
-上一节中提到的```Message Event```仅仅是众多```Event```的这一种，其他```Event```有群员加入群，离开群，私聊等等...
+上一节中提到的`Message Event`仅仅是众多`Event`的这一种，其他`Event`有：群员加入群，离开群，私聊等等...
 
-具体doc暂不提供，现可翻阅源码[**BotEvents.kt**](https://github.com/mamoe/mirai/blob/master/mirai-core/src/commonMain/kotlin/net.mamoe.mirai/event/events/BotEvents.kt)，查看注释。当前事件仍在扩充中，可能有一定不足。
+具体事件文档暂不提供，可翻阅源码[**BotEvents.kt**](https://github.com/mamoe/mirai/blob/master/mirai-core/src/commonMain/kotlin/net.mamoe.mirai/event/events/BotEvents.kt)，查看注释。当前事件仍在扩充中，可能有一定不足。
 
 下面我们开始示例对一些事件进行监听。
 
-
-
 ## 尝试监听事件-Try Subscribing Events
 
 ### 监听加群事件
 
-在代码中的```miraiBot.join()```前添加
+在代码中的`miraiBot.join()`前添加
 
 ```kotlin
 miraiBot.subscribeAlways<MemberJoinEvent> {
-        it.group.sendMessage("欢迎 ${it.member.nameCardOrNick} 加入本群！")
+    it.group.sendMessage(PlainText("欢迎 ${it.member.nameCardOrNick} 加入本群！"))
 }
 ```
 
@@ -64,8 +60,8 @@ miraiBot.subscribeAlways<MemberJoinEvent> {
 在代码中添加
 
 ```kotlin
-miraiBot.subscribeAlways<MemberMuteEvent> (){
+miraiBot.subscribeAlways<MemberMuteEvent> {
-        it.group.sendMessage("恭喜老哥 ${it.member.nameCardOrNick} 喜提禁言套餐一份")
+    it.group.sendMessage(PlainText("恭喜老哥 ${it.member.nameCardOrNick} 喜提禁言套餐一份"))
 }
 ```
 
@@ -81,12 +77,12 @@ package net.mamoe.mirai.simpleloader
 import kotlinx.coroutines.*
 import net.mamoe.mirai.Bot
 import net.mamoe.mirai.alsoLogin
-import net.mamoe.mirai.event.subscribeMessages
 import net.mamoe.mirai.contact.nameCardOrNick
-import net.mamoe.mirai.contact.sendMessage
 import net.mamoe.mirai.event.events.MemberJoinEvent
 import net.mamoe.mirai.event.events.MemberMuteEvent
 import net.mamoe.mirai.event.subscribeAlways
+import net.mamoe.mirai.event.subscribeMessages
+import net.mamoe.mirai.message.data.PlainText
 
 suspend fun main() {
     val qqId = 10000L//Bot的QQ号，需为Long类型，在结尾处添加大写L
@@ -103,14 +99,13 @@ suspend fun main() {
         }
     }
     miraiBot.subscribeAlways<MemberJoinEvent> {
-        it.group.sendMessage("欢迎 ${it.member.nameCardOrNick} 加入本群！")
+        it.group.sendMessage(PlainText("欢迎 ${it.member.nameCardOrNick} 加入本群！"))
     }
-    miraiBot.subscribeAlways<MemberMuteEvent> (){
+    miraiBot.subscribeAlways<MemberMuteEvent> {
-        it.group.sendMessage("恭喜老哥 ${it.member.nameCardOrNick} 喜提禁言套餐一份")
+        it.group.sendMessage(PlainText("恭喜老哥 ${it.member.nameCardOrNick} 喜提禁言套餐一份"))
     }
     miraiBot.join() // 等待 Bot 离线, 避免主线程退出
 }
 ```
 
 下面可以参阅[Mirai Guide - Build For Mirai](/docs/guide_build_for_mirai.md)，对你的Mirai应用进行打包
-