diff --git a/backend/codegen/README.md b/backend/codegen/README.md new file mode 100644 index 000000000..013c05c7b --- /dev/null +++ b/backend/codegen/README.md @@ -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) diff --git a/backend/codegen/src/main/kotlin/net/mamoe/mirai/console/codegen/ValueSettingCodegen.kt b/backend/codegen/src/main/kotlin/net/mamoe/mirai/console/codegen/ValuePluginDataCodegen.kt similarity index 100% rename from backend/codegen/src/main/kotlin/net/mamoe/mirai/console/codegen/ValueSettingCodegen.kt rename to backend/codegen/src/main/kotlin/net/mamoe/mirai/console/codegen/ValuePluginDataCodegen.kt diff --git a/backend/mirai-console/README.md b/backend/mirai-console/README.md new file mode 100644 index 000000000..451b5aaee --- /dev/null +++ b/backend/mirai-console/README.md @@ -0,0 +1,3 @@ +# Mirai Console - Backend + +Mirai Console 后端模块. 发布为 `net.mamoe:mirai-console`. \ No newline at end of file diff --git a/backend/mirai-console/build.gradle.kts b/backend/mirai-console/build.gradle.kts index 745d77d1a..d520dd69e 100644 --- a/backend/mirai-console/build.gradle.kts +++ b/backend/mirai-console/build.gradle.kts @@ -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")) diff --git a/docs/Contributing.md b/docs/Contributing.md index d90a8dd4c..a562a15d4 100644 --- a/docs/Contributing.md +++ b/docs/Contributing.md @@ -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 查看详细说明。 \ No newline at end of file