75 lines
2.8 KiB
Markdown
75 lines
2.8 KiB
Markdown
# 星课表(starschedule)
|
||
|
||
面向高校师生的 Android 课程表。由拾光课程表精简而来:只保留课表核心能力,教务导入只适配正方,界面仅简体中文。
|
||
|
||
| 项 | 值 |
|
||
|---|---|
|
||
| 显示名 | 星课表 |
|
||
| 工程名 | `starschedule` |
|
||
| 安装包名 | `com.starschedule` |
|
||
| Kotlin 包名 | `com.xingheyuzhuan.shiguangschedule`(沿用原工程,未全量改名) |
|
||
| 当前版本 | `1.0.0`(versionCode `1`) |
|
||
| 最低系统 | Android 8.0(API 26) |
|
||
| 许可证 | Apache 2.0 |
|
||
|
||
完整文档在 [`docs/`](docs/README.md)。
|
||
|
||
## 能做什么
|
||
|
||
- 今日课表、周课表(多课表、自定义节次与学期)
|
||
- 课程增删改、按名称管理、调课、按周/日批量删除
|
||
- 正方教务导入(内置 `zhengfang.js`,不连外部适配仓库)
|
||
- JSON 导入导出、ICS 导出、本地 ZIP 与 WebDAV 备份
|
||
- 上课提醒、上课勿扰/静音、节假日跳过
|
||
- 课表样式与应用主题
|
||
- 四种桌面小组件
|
||
|
||
## 工程结构
|
||
|
||
```
|
||
starschedule/
|
||
├── app/ # Android 入口、闹钟、WorkManager、小组件
|
||
├── shared/ # Compose UI、业务、Room、正方脚本
|
||
├── gradle/ # 版本目录与 Wrapper
|
||
└── docs/ # 需求、使用、架构、开发说明
|
||
```
|
||
|
||
Gradle 模块:`:app`、`:shared`。
|
||
|
||
## 构建
|
||
|
||
需要 JDK 21。在 `starschedule/` 目录:
|
||
|
||
```bat
|
||
gradlew.bat :app:assembleDebug
|
||
```
|
||
|
||
```bash
|
||
./gradlew :app:assembleDebug
|
||
```
|
||
|
||
产物:`app/build/outputs/apk/debug/`,按 ABI 分包(`armeabi-v7a`、`arm64-v8a`、`x86_64`)。
|
||
|
||
依赖解析优先腾讯云 Maven,找不到时回落 Google Maven / Maven Central。详见 [构建与发布](docs/构建与发布.md)。
|
||
|
||
## 文档索引
|
||
|
||
| 文档 | 用途 |
|
||
|---|---|
|
||
| [需求文档](docs/需求文档.md) | 范围、功能与非功能需求、验收 |
|
||
| [用户使用说明](docs/用户使用说明.md) | 操作步骤 |
|
||
| [架构设计](docs/架构设计.md) | 模块、分层、关键数据流 |
|
||
| [开发文档](docs/开发文档.md) | 环境、约定、扩展入口 |
|
||
| [页面与导航](docs/页面与导航.md) | Destination 与界面对照 |
|
||
| [数据模型](docs/数据模型.md) | Room / DataStore / JSON / 备份 |
|
||
| [正方教务导入](docs/正方教务导入.md) | WebView、JS Bridge、脚本 |
|
||
| [构建与发布](docs/构建与发布.md) | Gradle、镜像、打包 |
|
||
| [隐私与数据](docs/隐私与数据.md) | 权限与本地数据 |
|
||
| [常见问题](docs/常见问题.md) | 导入、提醒、小组件排障 |
|
||
| [术语表](docs/术语表.md) | 领域名词 |
|
||
| [变更记录](docs/变更记录.md) | 版本说明 |
|
||
|
||
## 与拾光课程表的关系
|
||
|
||
本仓库是独立工程,工作区里的 `shiguangschedule`、`shiguang_warehouse` 仅作参考,运行时不依赖它们。正方脚本已内嵌在 `shared/src/commonMain/composeResources/files/zhengfang.js`。
|