docs: update README.md with new format and roadmap

This commit is contained in:
yovinchen 2024-11-27 13:37:01 +08:00
parent 49e83cea90
commit e03149377c

176
README.md
View File

@ -2,115 +2,77 @@
一个轻量级的个人记账应用,专注于隐私和离线使用。
## 🌟 特点
## 项目概述
- 🔒 完全离线运行,无需网络连接
- 📱 极简权限要求,仅使用必要的系统权限
- 💰 支持收入和支出记录
- 👥 支持多人记账
- 📊 按日期和类别统计
- 🎨 Material You 设计风格
本项目是一个使用 Kotlin 和 Jetpack Compose 开发的 Android 记账应用,采用 MVVM 架构,提供简洁直观的用户界面和丰富的记账功能。
## 🛠 技术栈
## 主要特性
- 语言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. 体验优化 (持续进行 )
- 深色模式支持
- 手势操作优化
- 快速记账小组件
- 多语言支持
- 自定义主题
- [ ] 数据导出和备份
- [ ] 预算管理
- [ ] 更多统计图表
- [ ] 自定义主题
## 📄 许可证
[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)
- [ ] 大数据量处理优化
- [ ] 启动速度优化
- [ ] 内存使用优化
- [ ] 缓存策略优化
- [ ] 数据库查询优化
### 7. 性能提升 (持续进行 )
- 大数据量处理优化
- 启动速度优化
- 内存使用优化
- 缓存策略优化
- 数据库查询优化
## 分支管理
@ -123,34 +85,34 @@
## 版本历史
### v1.1.0 (2024-01-10)
- 成员管理功能
- 成员管理功能
- 成员添加/编辑/删除
- 记账时关联成员
- 成员消费统计
- 🎨 UI/UX 优化
- UI/UX 优化
- 记录展示优化
- 月度统计界面
- 分组展示优化
- 📊 数据管理
- 数据管理
- 记录筛选增强
- 数据库性能优化
- 状态管理重构
### v1.0.0 (2024-01-05)
- 基础记账功能
- 基础记账功能
- 收入/支出记录
- 金额、日期、分类、备注管理
- 🎨 Material 3 设计界面
- Material 3 设计界面
- 深色/浅色主题切换
- 主题色自定义
- 📊 分类管理
- 分类管理
- 默认分类预设
- 自定义分类支持
- 分类编辑与删除
- 📅 月度统计
- 月度统计
- 月度收支总览
- 月份快速切换
- 🗓️ 自定义日期选择器
- 自定义日期选择器
## 贡献指南
@ -160,10 +122,14 @@
4. 推送到分支 (`git push origin feature/AmazingFeature`)
5. 提交 Pull Request
## 许可证
本项目采用 MIT 许可证 - 查看 [LICENSE](LICENSE) 文件了解详细信息
## 联系方式
- 作者YovinChen
- 邮箱gzh298255@gmail.com
- 邮箱:yovinchen@outlook.com
- 博客:[blog.hhdxw.top](https://blog.hhdxw.top)
## 致谢