Rewrite docs for beginners

docs/ConfiguringProjects.md

@@ -4,9 +4,9 @@
 
 ## 模块说明
 
-Mirai Console 分前后端模块实现。开发插件只需要针对同一个后端开发，便可以运行在所有前端。
+Mirai Console 分前后端模块实现。开发插件**只需要针对同一个后端开发**，便可以运行在所有前端。
 
-目前的前端有：
+现有的前端如下所示。你不需要下载它们，因为插件的开发都是通用的。
 
 - `mirai-console-terminal`: JVM 终端前端，适合在测试环境或服务器运行。
 - [`MiraiAndroid`](https://github.com/mzdluo123/MiraiAndroid): Android 应用前端，可兼容大部分 Mirai Console 插件。
@@ -16,11 +16,25 @@ Mirai Console 分前后端模块实现。开发插件只需要针对同一个后
 
 `mirai-console` 与 `mirai-core` **同步版本**发布。版本号见 [mirai](https://github.com/mamoe/mirai/blob/dev/docs/ConfiguringProjects.md#%E9%80%89%E6%8B%A9%E7%89%88%E6%9C%AC)。
 
+通常使用最新版本的稳定版本即可。
+
 ## 配置项目
 
-请选择以下三种方法之一。不推荐使用 Maven 构建 Mirai Console 插件。
+请选择以下四种方法之一。不推荐使用 Maven 构建 Mirai Console 插件。
 
-### A.使用模板项目
+### A.使用项目创建工具
+
+Mirai 为 IntelliJ IDEA 或 Android Studio 提供插件: [安装方法](https://github.com/mamoe/mirai/blob/dev/docs/Preparations.md#%E5%AE%89%E8%A3%85-ide-%E6%8F%92%E4%BB%B6)
+
+之后便可在新建项目时选择 `Mirai`，将会自动套用 [模板项目](https://github.com/project-mirai/mirai-console-plugin-template)。
+
+![](.ConfiguringProjects_images/6d010b1a.png)
+
+![](.ConfiguringProjects_images/a6a3b24b.png)
+
+> 现在你已经配置好了项目，开始阅读 [Core 开发文档](https://github.com/mamoe/mirai/blob/dev/docs/CoreAPI.md) 或 [Console 开发文档](README.md#mirai-console)
+
+### B.使用模板项目
 
 Mirai 鼓励插件开发者将自己的作品开源，并为此提供了模板项目。
 
@@ -32,15 +46,17 @@ Mirai 鼓励插件开发者将自己的作品开源，并为此提供了模板
 
 3. 克隆项目，检查并修改生成的属性
 
-### B.使用 Gradle 插件配置项目
+> 现在你已经配置好了项目，开始阅读 [Core 开发文档](https://github.com/mamoe/mirai/blob/dev/docs/CoreAPI.md) 或 [Console 开发文档](README.md#mirai-console)
+
+### C.使用 Gradle 插件配置项目
 
 `VERSION`: [选择版本](#选择版本)
 
 若使用 `build.gradle.kts`:
 ```kotlin
 plugins {
-    kotlin("jvm") version "1.4.31"
-    kotlin("serialization") version "1.4.31"
+    kotlin("jvm") version "1.4.32"
+    kotlin("serialization") version "1.4.32"
     
     id("net.mamoe.mirai-console") version "VERSION"
 }
@@ -49,8 +65,8 @@ plugins {
 若使用 `build.gradle`:
 ```groovy
 plugins {
-    id 'org.jetbrains.kotlin.jvm' version '1.4.31'
-    id 'org.jetbrains.kotlin.plugin.serialization' version '1.4.31'
+    id 'org.jetbrains.kotlin.jvm' version '1.4.32'
+    id 'org.jetbrains.kotlin.plugin.serialization' version '1.4.32'
     
     id 'net.mamoe.mirai-console' version 'VERSION'
 }
@@ -60,9 +76,9 @@ plugins {
 
 可以在 [README](../tools/gradle-plugin/README.md#mirai-console-gradle-plugin) 获取详细的 Gradle 插件使用方法。
 
-> 现在你已经配置好了项目，返回 [开发文档索引](README.md#mirai-console)
+> 现在你已经配置好了项目，开始阅读 [Core 开发文档](https://github.com/mamoe/mirai/blob/dev/docs/CoreAPI.md) 或 [Console 开发文档](README.md#mirai-console)
 
-### C.手动配置项目
+### D.手动配置项目
 
 不推荐这种方式，因为通常还需要配置一些不容易配置的编译器参数。
 
@@ -80,5 +96,4 @@ dependencies {
 
 注意，在打包插件时必须将依赖一并打包进插件 JAR，且排除 `mirai-core`，`mirai-console` 和[它们的间接依赖](https://mvnrepository.com/artifact/net.mamoe/mirai-core-jvm/2.4.0)，否则可能导致兼容性问题。
 
-> 现在你已经配置好了项目，返回 [开发文档索引](README.md#mirai-console)
-
+> 现在你已经配置好了项目，开始阅读 [Core 开发文档](https://github.com/mamoe/mirai/blob/dev/docs/CoreAPI.md) 或 [Console 开发文档](README.md#mirai-console)

docs/Plugins.md

@@ -407,7 +407,7 @@ object MyData : AutoSavePluginData() {
 ```
 
 ### 打包插件
-若 [使用了 Mirai Console Gradle 插件](ConfiguringProjects.md#b使用-gradle-插件配置项目), 执行 Gradle 任务 `buildPlugin` 即可打包插件 JAR. 之后可以在 `build/mirai/` 找到 JAR 文件. 这个文件可以放入 Mirai Console `plugins` 目录中加载.
+若 [使用了 Mirai Console Gradle 插件](ConfiguringProjects.md#c使用-gradle-插件配置项目), 执行 Gradle 任务 `buildPlugin` 即可打包插件 JAR. 之后可以在 `build/mirai/` 找到 JAR 文件. 这个文件可以放入 Mirai Console `plugins` 目录中加载.
 
 若没有使用, 请打包插件并附带资源文件和所有依赖到一个单独的 JAR.
 

docs/README.md

@@ -2,10 +2,11 @@
 
 欢迎来到 mirai-console 开发文档!
 
-**Mirai Console 基于 [Mirai](https://github.com/mamoe/mirai)，因此请先阅读 [Mirai 文档](https://github.com/mamoe/mirai/tree/dev/docs)。**
+**Mirai Console 基于 [Mirai](https://github.com/mamoe/mirai)，因此请先阅读 [Mirai 文档](https://github.com/mamoe/mirai/blob/dev/docs/CoreAPI.md)。**
 
-- **[配置项目](ConfiguringProjects.md)**
-- **[启动 Console](Run.md)**
+> 其他链接：
+> - **[如何配置 Mirai Console 项目](ConfiguringProjects.md)**
+> - **[如何启动 Mirai Console](Run.md)**
 
 ### 后端插件开发基础
 

docs/Run.md

@@ -4,14 +4,11 @@ Mirai Console 可以独立启动，也可以被嵌入到某个应用中。
 
 ## 使用工具自动独立启动
 
-独立启动 Mirai Console 作为一个应用程序，由 Console 扫描 plugins 目录加载插件。
-
-官方: https://github.com/iTXTech/mirai-console-loader  
-第三方: https://github.com/LXY1226/MiraiOK
+该部分文档已经转移到 [用户手册](https://github.com/mamoe/mirai/blob/dev/docs/UserManual.md)。
 
 ## 嵌入应用启动（实验性）
 
-将 Mirai Console 作为一个依赖嵌入一个 JVM 应用启动，开发者主动加载插件。
+将 Mirai Console 作为一个依赖嵌入一个 JVM 应用启动，开发者主动加载插件。尤其适合在开发时启动真实环境的测试。
 
 ### 环境
 
@@ -24,12 +21,9 @@ Mirai Console 可以独立启动，也可以被嵌入到某个应用中。
 
 `build.gradle.kts`:
 ```kotlin
-repositories {
-    jcenter()
-}
 dependencies {
-    implementation("net.mamoe:mirai-console-terminal:2.0.0") // 自行替换版本
-    implementation("net.mamoe:mirai-core:2.0.0")
+    api("net.mamoe:mirai-console-terminal:2.0.0") // 自行替换版本
+    api("net.mamoe:mirai-core:2.0.0")
 }
 ```
 
@@ -55,8 +49,8 @@ Plugin.load() // 扩展函数
 Plugin.enable() // 扩展函数 
 
 // Java
-PluginManager.INSTANCE.loadPlugin(Plugin)
-PluginManager.INSTANCE.enablePlugin(Plugin)
+PluginManager.INSTANCE.loadPlugin(Plugin.INSTANCE)
+PluginManager.INSTANCE.enablePlugin(Plugin.INSTANCE)
 ```
 
 但注意：这种方法目前是实验性的——一些特定的功能如注册扩展可能不会正常工作。