xfy
50a42be9bc
为各模块和子目录添加 AGENTS.md，便于 AI 助手理解项目结构。 Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
53 lines
2.0 KiB
Markdown
53 lines
2.0 KiB
Markdown
<!-- Generated: 2026-05-20 | Updated: 2026-05-20 -->
|
||
|
||
# YaYa
|
||
|
||
## Purpose
|
||
YaYa 是一款基于 Kotlin Multiplatform + Compose Multiplatform 构建的日历应用，同时支持 Android 和 iOS 平台。应用功能包括农历显示、节气标注、节假日信息、个人班次排期（WORK/OFF 循环）以及月/周/年三种视图切换。
|
||
|
||
## Key Files
|
||
|
||
| File | Description |
|
||
|------|-------------|
|
||
| `build.gradle.kts` | 根项目 Gradle 构建设置 |
|
||
| `settings.gradle.kts` | Gradle 项目包含模块声明 |
|
||
| `gradle.properties` | Gradle 构建设置与缓存配置 |
|
||
| `gradle/libs.versions.toml` | 版本目录（依赖版本统一管理） |
|
||
| `CLAUDE.md` | 项目开发指南与架构文档 |
|
||
| `CHANGELOG.md` | 版本变更历史 |
|
||
| `DEVELOPMENT.md` | 性能追踪与开发工具说明 |
|
||
| `COMMENTS.md` | KDoc 注释规范 |
|
||
|
||
## Subdirectories
|
||
|
||
| Directory | Purpose |
|
||
|-----------|---------|
|
||
| `androidApp/` | Android 应用壳层模块（见 `androidApp/AGENTS.md`） |
|
||
| `shared/` | KMP 共享模块：所有 UI、ViewModel 和业务逻辑（见 `shared/AGENTS.md`） |
|
||
| `iosApp/` | iOS Xcode 项目（见 `iosApp/AGENTS.md`） |
|
||
| `gradle/` | Gradle Wrapper 文件 |
|
||
|
||
## For AI Agents
|
||
|
||
### Working In This Directory
|
||
- 所有依赖版本在 `gradle/libs.versions.toml` 中声明
|
||
- 修改依赖后需同步 Gradle
|
||
- 构建配置在根 `build.gradle.kts` 和各模块 `build.gradle.kts` 中
|
||
|
||
### Testing Requirements
|
||
- 共享模块测试：`./gradlew :shared:allTests` 或 `:shared:testAndroidHostTest`
|
||
- Android 构建：`./gradlew :androidApp:assembleDebug`
|
||
|
||
### Common Patterns
|
||
- Kotlin 包名统一为 `plus.rua.project`
|
||
- UI 组件在 `plus.rua.project.ui` 包下
|
||
- 平台相关代码通过 `expect/actual` 机制隔离
|
||
|
||
## Dependencies
|
||
|
||
### External
|
||
- Kotlin 2.3.21, Compose Multiplatform 1.11.0, Material 3 1.10.0-alpha05
|
||
- `kotlinx-datetime` 0.8.0, `tyme4kt`（农历/节气）, `sketch` 4.4.0（GIF）
|
||
- AGP 9.2.1, compileSdk/targetSdk 37, minSdk 24
|
||
|
||
<!-- MANUAL: --> |