Update docs

This commit is contained in:
Him188 2020-09-20 14:25:54 +08:00
parent 9acaa7882d
commit 30a10f56d0
5 changed files with 32 additions and 1 deletions

View File

@ -0,0 +1,6 @@
# Mirai Console - Backend.codegen
后端代码生成模块,用于最小化重复代码的人工成本。
- `MessageScope` 代码生成: [MessageScopeCodegen.kt: Line 33](src/main/kotlin/net/mamoe/mirai/console/codegen/MessageScopeCodegen.kt#L33)
- `Value``PluginData` 相关代码生成: [ValueSettingCodegen.kt: Line 18](src/main/kotlin/net/mamoe/mirai/console/codegen/ValuePluginDataCodegen.kt#L18)

View File

@ -0,0 +1,3 @@
# Mirai Console - Backend
Mirai Console 后端模块. 发布为 `net.mamoe:mirai-console`.

View File

@ -69,7 +69,6 @@ dependencies {
smartApi(kotlinx("coroutines-jdk8", Versions.coroutines))
smartApi("net.mamoe.yamlkt:yamlkt:${Versions.yamlkt}")
smartApi("com.vdurmont:semver4j:3.1.0")
testApi("net.mamoe:mirai-core-qqandroid:${Versions.core}")
testApi(kotlin("stdlib-jdk8"))

View File

@ -1,2 +1,25 @@
# Mirai Console - Contributing
感谢你来到这里,感谢你对 Mirai Console 做的一切贡献。
## 开发 Mirai Console
### 模块
Mirai Console 项目由四个模块组成后端前端Gradle 插件Intellij 插件。
```
/
|--- backend 后端
| |--- codegen 后端代码生成工具
| `--- mirai-console 后端主模块, 发布为 net.mamoe:mirai-console
|--- buildSrc 项目构建
|--- frontend 前端
| `--- mirai-console-terminal 终端前端,发布为 net.mamoe:mirai-console-terminal
`--- tools 开发工具
|--- compiler-common 编译器通用模块
|--- gradle-plugin Gradle 插件,发布为 net.mamoe.mirai-console
`--- intellij-plugin IntelliJ 平台 IDE 插件,发布为 Mirai Console
```
请前往各模块内的 README.md 查看详细说明。