docs: update README.md with new format and roadmap
This commit is contained in:
parent
49e83cea90
commit
e03149377c
176
README.md
176
README.md
@ -2,115 +2,77 @@
|
|||||||
|
|
||||||
一个轻量级的个人记账应用，专注于隐私和离线使用。
|
一个轻量级的个人记账应用，专注于隐私和离线使用。
|
||||||
|
|
||||||
## 🌟 特点
|
## 项目概述
|
||||||
|
|
||||||
- 🔒 完全离线运行，无需网络连接
|
本项目是一个使用 Kotlin 和 Jetpack Compose 开发的 Android 记账应用，采用 MVVM 架构，提供简洁直观的用户界面和丰富的记账功能。
|
||||||
- 📱 极简权限要求，仅使用必要的系统权限
|
|
||||||
- 💰 支持收入和支出记录
|
|
||||||
- 👥 支持多人记账
|
|
||||||
- 📊 按日期和类别统计
|
|
||||||
- 🎨 Material You 设计风格
|
|
||||||
|
|
||||||
## 🛠 技术栈
|
## 主要特性
|
||||||
|
|
||||||
- 语言：Kotlin
|
- 完全离线运行，无需网络连接
|
||||||
- UI框架：Jetpack Compose
|
- 极简权限要求，仅使用必要的系统权限
|
||||||
- 数据库：Room
|
- 支持收入和支出记录
|
||||||
- 架构：MVVM
|
- 支持多人记账
|
||||||
|
- 按日期和类别统计
|
||||||
|
|
||||||
## 📱 功能
|
## 技术栈
|
||||||
|
|
||||||
### 记账管理
|
- 开发语言：Kotlin
|
||||||
- 收入和支出记录
|
- UI 框架：Jetpack Compose
|
||||||
- 自定义分类管理
|
- 架构模式：MVVM
|
||||||
- 日期和时间选择
|
- 数据存储：Room Database
|
||||||
- 备注说明
|
- 依赖注入：Hilt
|
||||||
|
- 异步处理：Kotlin Coroutines
|
||||||
|
|
||||||
### 成员管理
|
## 开发路线图
|
||||||
- 多人记账支持
|
|
||||||
- 成员关联记录
|
|
||||||
- 按成员筛选统计
|
|
||||||
|
|
||||||
### 数据统计
|
### 1. 基础记账 (已完成 )
|
||||||
- 月度收支统计
|
- 收入/支出记录管理
|
||||||
- 分类统计
|
- 分类管理系统
|
||||||
- 每日收支明细
|
- 自定义日期选择器
|
||||||
|
- Material 3 设计界面
|
||||||
|
- 深色/浅色主题切换
|
||||||
|
- 主题色自定义
|
||||||
|
|
||||||
## 🔒 隐私保护
|
### 2. 成员系统 (已完成 )
|
||||||
|
- 成员添加/编辑/删除
|
||||||
|
- 记账时选择相关成员
|
||||||
|
- 成员消费统计
|
||||||
|
- 成员间账单分摊
|
||||||
|
|
||||||
- 完全离线运行，数据存储在本地
|
### 3. 数据分析 (进行中 )
|
||||||
- 无需任何网络权限
|
- 支出/收入趋势图表
|
||||||
- 最小化系统权限要求
|
- 分类占比饼图
|
||||||
|
- 月度/年度报表
|
||||||
|
- 成员消费分析
|
||||||
|
- 自定义统计周期
|
||||||
|
|
||||||
## 📝 系统要求
|
### 4. 数据管理 (计划中 )
|
||||||
|
- 导出 CSV/Excel 功能
|
||||||
|
- 云端备份支持
|
||||||
|
- 数据迁移工具
|
||||||
|
- 定期自动备份
|
||||||
|
- 备份加密功能
|
||||||
|
|
||||||
- Android 5.0 (API 21) 或更高版本
|
### 5. 预算管理 (计划中 )
|
||||||
- 存储权限（用于数据备份，可选）
|
- 月度预算设置
|
||||||
|
- 预算超支提醒
|
||||||
|
- 分类预算管理
|
||||||
|
- 成员预算管理
|
||||||
|
- 预算分析报告
|
||||||
|
|
||||||
## 🔜 未来计划
|
### 6. 体验优化 (持续进行 )
|
||||||
|
- 深色模式支持
|
||||||
|
- 手势操作优化
|
||||||
|
- 快速记账小组件
|
||||||
|
- 多语言支持
|
||||||
|
- 自定义主题
|
||||||
|
|
||||||
- [ ] 数据导出和备份
|
### 7. 性能提升 (持续进行 )
|
||||||
- [ ] 预算管理
|
- 大数据量处理优化
|
||||||
- [ ] 更多统计图表
|
- 启动速度优化
|
||||||
- [ ] 自定义主题
|
- 内存使用优化
|
||||||
|
- 缓存策略优化
|
||||||
## 📄 许可证
|
- 数据库查询优化
|
||||||
|
|
||||||
[MIT License](LICENSE)
|
|
||||||
|
|
||||||
## 开发计划
|
|
||||||
|
|
||||||
### 1. 基础功能 (已完成)
|
|
||||||
- [x] 收入/支出记录管理
|
|
||||||
- [x] 分类管理系统
|
|
||||||
- [x] 默认分类
|
|
||||||
- [x] 自定义分类
|
|
||||||
- [x] 分类编辑/删除
|
|
||||||
- [x] 自定义日期选择器
|
|
||||||
- [x] Material 3 设计界面
|
|
||||||
- [x] 深色/浅色主题切换
|
|
||||||
- [x] 主题色自定义
|
|
||||||
|
|
||||||
### 2. 成员管理功能 (已完成)
|
|
||||||
- [x] 成员添加/编辑/删除
|
|
||||||
- [x] 记账时选择相关成员
|
|
||||||
- [x] 成员消费统计
|
|
||||||
- [x] 成员间账单分摊
|
|
||||||
|
|
||||||
### 3. 数据统计与可视化 (feature/statistics)
|
|
||||||
- [ ] 支出/收入趋势图表
|
|
||||||
- [ ] 分类占比饼图
|
|
||||||
- [ ] 月度/年度报表
|
|
||||||
- [ ] 成员消费分析
|
|
||||||
- [ ] 自定义统计周期
|
|
||||||
|
|
||||||
### 4. 数据导出与备份 (feature/backup)
|
|
||||||
- [ ] 导出 CSV/Excel 功能
|
|
||||||
- [ ] 云端备份支持
|
|
||||||
- [ ] 数据迁移工具
|
|
||||||
- [ ] 定期自动备份
|
|
||||||
- [ ] 备份加密功能
|
|
||||||
|
|
||||||
### 5. 预算管理 (feature/budget)
|
|
||||||
- [ ] 月度预算设置
|
|
||||||
- [ ] 预算超支提醒
|
|
||||||
- [ ] 分类预算管理
|
|
||||||
- [ ] 成员预算管理
|
|
||||||
- [ ] 预算分析报告
|
|
||||||
|
|
||||||
### 6. 用户体验优化 (feature/ux-enhancement)
|
|
||||||
- [x] 深色模式支持
|
|
||||||
- [ ] 手势操作优化
|
|
||||||
- [ ] 快速记账小组件
|
|
||||||
- [ ] 多语言支持
|
|
||||||
- [ ] 自定义主题
|
|
||||||
|
|
||||||
### 7. 性能优化 (feature/performance)
|
|
||||||
- [ ] 大数据量处理优化
|
|
||||||
- [ ] 启动速度优化
|
|
||||||
- [ ] 内存使用优化
|
|
||||||
- [ ] 缓存策略优化
|
|
||||||
- [ ] 数据库查询优化
|
|
||||||
|
|
||||||
## 分支管理
|
## 分支管理
|
||||||
|
|
||||||
@ -123,34 +85,34 @@
|
|||||||
## 版本历史
|
## 版本历史
|
||||||
|
|
||||||
### v1.1.0 (2024-01-10)
|
### v1.1.0 (2024-01-10)
|
||||||
- ✨ 成员管理功能
|
- 成员管理功能
|
||||||
- 成员添加/编辑/删除
|
- 成员添加/编辑/删除
|
||||||
- 记账时关联成员
|
- 记账时关联成员
|
||||||
- 成员消费统计
|
- 成员消费统计
|
||||||
- 🎨 UI/UX 优化
|
- UI/UX 优化
|
||||||
- 记录展示优化
|
- 记录展示优化
|
||||||
- 月度统计界面
|
- 月度统计界面
|
||||||
- 分组展示优化
|
- 分组展示优化
|
||||||
- 📊 数据管理
|
- 数据管理
|
||||||
- 记录筛选增强
|
- 记录筛选增强
|
||||||
- 数据库性能优化
|
- 数据库性能优化
|
||||||
- 状态管理重构
|
- 状态管理重构
|
||||||
|
|
||||||
### v1.0.0 (2024-01-05)
|
### v1.0.0 (2024-01-05)
|
||||||
- ✨ 基础记账功能
|
- 基础记账功能
|
||||||
- 收入/支出记录
|
- 收入/支出记录
|
||||||
- 金额、日期、分类、备注管理
|
- 金额、日期、分类、备注管理
|
||||||
- 🎨 Material 3 设计界面
|
- Material 3 设计界面
|
||||||
- 深色/浅色主题切换
|
- 深色/浅色主题切换
|
||||||
- 主题色自定义
|
- 主题色自定义
|
||||||
- 📊 分类管理
|
- 分类管理
|
||||||
- 默认分类预设
|
- 默认分类预设
|
||||||
- 自定义分类支持
|
- 自定义分类支持
|
||||||
- 分类编辑与删除
|
- 分类编辑与删除
|
||||||
- 📅 月度统计
|
- 月度统计
|
||||||
- 月度收支总览
|
- 月度收支总览
|
||||||
- 月份快速切换
|
- 月份快速切换
|
||||||
- 🗓️ 自定义日期选择器
|
- 自定义日期选择器
|
||||||
|
|
||||||
## 贡献指南
|
## 贡献指南
|
||||||
|
|
||||||
@ -160,10 +122,14 @@
|
|||||||
4. 推送到分支 (`git push origin feature/AmazingFeature`)
|
4. 推送到分支 (`git push origin feature/AmazingFeature`)
|
||||||
5. 提交 Pull Request
|
5. 提交 Pull Request
|
||||||
|
|
||||||
|
## 许可证
|
||||||
|
|
||||||
|
本项目采用 MIT 许可证 - 查看 [LICENSE](LICENSE) 文件了解详细信息
|
||||||
|
|
||||||
## 联系方式
|
## 联系方式
|
||||||
|
|
||||||
- 作者：YovinChen
|
- 作者：YovinChen
|
||||||
- 邮箱：gzh298255@gmail.com
|
- 邮箱：yovinchen@outlook.com
|
||||||
- 博客：[blog.hhdxw.top](https://blog.hhdxw.top)
|
- 博客：[blog.hhdxw.top](https://blog.hhdxw.top)
|
||||||
|
|
||||||
## 致谢
|
## 致谢
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user