docs(readme): expand detailed usage, architecture, testing (AirTest), and setup

This commit is contained in:
2026-03-01 00:15:18 +08:00
parent 1aab8b2d45
commit 1896f42f1b

View File

@@ -1,16 +1,42 @@
# CheckShot # CheckShot - Android 图片检查与拼图工具
Android 图片检查与拼图工具。实现了水印、拼图、设置等核心功能,配合 AirTest 自动化测试。 CheckShot 是一个面向 Android 图片处理与检查工具,包含水印处理、拼图合成、以及丰富的设置能力,配合 AirTest 自动化测试用例,帮助实现端到端的图像工作流
核心特性 核心功能
- 水印模块:时间水印、地点水印、三种预设样式。 - 水印设置
- 拼图模块:多图合成,固定模板,图片替换/删除,合成质量控制 - 时间水印:拍摄后在左下角叠加时间戳,格式固定为 "yyyy年-MM月-dd日 HH:mm:ss"
- 设置:默认合成布局、默认水印样式、默认主题、巡检员信息等 - 地点水印:优先通过 Geocoder 联网解析地址,失败时回落显示经纬度。可在设置中配置校准方式
- 测试AirTest 集成用例,覆盖水印、相册、拼图、设置等场景 - 样式:提供三种预设样式(默认/简约/醒目),并可在设置中预览和应用
- 多图拼图(合成)模块
- 布局规则:核心布局为 2x2 网格,且支持扩展布局如 1+3、3+1、1+2、2+1、单图等图片自动缩放裁剪以适配网格。
- 核心能力:图片拼接、模板化布局编辑(替换/删除图片)、合成质量控制(分辨率/清晰度)。
- 交互:支持替换网格中的图片、删除图片、添加新图片、设置合成质量和文本水印文本。
- 设置与通用配置
- 水印设置、合成设置、通用设置、关于等配置项,均可通过设置界面调整。
- 测试与自动化
- 集成 AirTest 测试用例,覆盖水印、相册、拼图、设置等场景,便于回归验证。
架构与实现要点
- Watermark时间文本来自系统时间地点文本通过 LocationHelper/Geocoder 获取。
- Puzzle通过 Bitmap 拼接与 Canvas/Matrix 实现多种布局,支持图片替换、删除与质量控制。
- Settings使用 DataStore 保存用户偏好。
快速开始 快速开始
- 构建./gradlew assembleDebug - 构建与运行
- 安装adb install -r app/build/outputs/apk/debug/app-debug.apk - 构建调试 APK`./gradlew assembleDebug`
- AirTestairtest run test/airtest/... - 在设备/模拟器上安装:`adb install -r app/build/outputs/apk/debug/app-debug.apk`
- AirTest 测试
- 运行测试用例(需安装 AirTest 及依赖):`airtest run test/airtest/... --device Android:///`
如需更多安装与运行指南,请查看 respective CI/CD 或文档。 项目结构与升级
- 主要代码位于:
- app/src/main/... 业务代码与 UI 组件
- app/src/test/... 单元测试
- test/airtest/... AirTest 的 UI 测试用例
- README 作为版本演进的记录,后续变更请同步更新。
持续集成与发布
- 建议在 CI 中执行编译、单元测试、AirTest 测试并在通过后打包发行版。
联系与贡献
- 如需进一步定制文档结构,或需要将某些部分拆分为单独的开发指南,请告知偏好。