Kuukiyomi 项目教程

1. 项目目录结构及介绍

Kuukiyomi 项目的目录结构如下：

kuukiyomi/
├── app/
│   ├── buildSrc/
│   ├── config/detekt/
│   ├── core-metadata/
│   ├── core/
│   ├── data/
│   ├── domain/
│   ├── gradle/
│   ├── i18n/
│   ├── macrobenchmark/
│   ├── presentation-core/
│   ├── presentation-widget/
│   ├── source-api/
│   ├── source-local/
│   ├── editorconfig
│   ├── gitattributes
│   ├── gitignore
│   ├── CODE_OF_CONDUCT.md
│   ├── CONTRIBUTING.md
│   ├── LICENSE
│   ├── README.md
│   ├── build.gradle.kts
│   ├── gradle.properties
│   ├── gradlew
│   ├── gradlew.bat
│   ├── settings.gradle.kts
├── build.gradle.kts
├── gradle.properties
├── gradlew
├── gradlew.bat
├── settings.gradle.kts

目录介绍：

• app/: 应用程序的主要代码目录。
  • buildSrc/: 包含构建脚本的源代码。
  • config/detekt/: 包含代码质量检查工具 Detekt 的配置文件。
  • core-metadata/: 核心元数据模块。
  • core/: 核心功能模块。
  • data/: 数据处理模块。
  • domain/: 领域逻辑模块。
  • gradle/: Gradle 构建脚本目录。
  • i18n/: 国际化资源目录。
  • macrobenchmark/: 宏基准测试模块。
  • presentation-core/: 核心展示模块。
  • presentation-widget/: 展示小部件模块。
  • source-api/: API 源模块。
  • source-local/: 本地源模块。
  • editorconfig: 编辑器配置文件。
  • gitattributes: Git 属性配置文件。
  • gitignore: Git 忽略文件配置。
  • CODE_OF_CONDUCT.md: 行为准则文件。
  • CONTRIBUTING.md: 贡献指南文件。
  • LICENSE: 项目许可证文件。
  • README.md: 项目介绍文件。
  • build.gradle.kts: 应用程序的 Gradle 构建脚本。
  • gradle.properties: Gradle 属性配置文件。
  • gradlew: Gradle 包装器脚本。
  • gradlew.bat: Windows 下的 Gradle 包装器脚本。
  • settings.gradle.kts: Gradle 设置脚本。

2. 项目启动文件介绍

Kuukiyomi 项目的启动文件主要包括以下几个：

• gradlew: Unix/Linux 系统下的 Gradle 包装器脚本，用于启动项目的构建过程。
• gradlew.bat: Windows 系统下的 Gradle 包装器脚本，用于启动项目的构建过程。
• build.gradle.kts: 项目的 Gradle 构建脚本，定义了项目的构建配置和依赖。
• settings.gradle.kts: 项目的 Gradle 设置脚本，定义了项目的模块和依赖关系。

3. 项目配置文件介绍

Kuukiyomi 项目的主要配置文件包括：

• gradle.properties: 包含 Gradle 构建工具的属性配置，如 JVM 参数、构建缓存设置等。
• build.gradle.kts: 定义了项目的构建配置，包括依赖管理、插件应用、任务定义等。
• settings.gradle.kts: 定义了项目的模块和依赖关系，以及项目的根目录配置。
• config/detekt/detekt.yml: 代码质量检查工具 Detekt 的配置文件，定义了代码风格和质量检查规则。
• editorconfig: 编辑器配置文件，定义了代码格式化规则，确保不同开发者在不同编辑器中保持一致的代码风格。

通过以上配置文件，开发者可以自定义项目的构建过程、代码质量检查规则以及编辑器的行为，确保项目的可维护性和一致性。