完善README文档，添加详细项目介绍和技术说明

2026-02-25 23:08:49 +08:00
parent 285c1443cd
commit 029d32fb4f
1 changed files with 156 additions and 2 deletions
--- a/README.md
+++ b/README.md
@@ -1,3 +1,157 @@
-# flomo-ai
+# Flomo-AI Android 客户端

-开发手机版本的flomo-ai客户端
+<p align="center">
+  <img src="Screenshot_20241001_222239_配置页面修改.png" alt="应用截图" width="300"/>
+</p>
+
+<p align="center">
+  <a href="#features"><img src="https://img.shields.io/badge/功能-丰富-blue" alt="功能"></a>
+  <a href="#tech-stack"><img src="https://img.shields.io/badge/技术栈-Kotlin-green" alt="技术栈"></a>
+  <a href="#requirements"><img src="https://img.shields.io/badge/最低支持-Android%209+-orange" alt="Android版本"></a>
+</p>
+
+## 📱 项目简介
+
+Flomo-AI 是一款基于 Android 平台的笔记应用客户端，专为移动端用户设计。该应用结合了现代化的 UI 设计和高效的笔记管理功能，让用户能够随时随地记录灵感和重要信息。
+
+## 🌟 主要特性
+
+### 核心功能
+- ✨ **现代化界面设计** - 采用 Material Design 3 规范
+- 📝 **便捷笔记记录** - 快速创建和编辑笔记
+- 🎨 **个性化定制** - 支持背景图片和状态栏颜色自定义
+- 🔐 **安全可靠** - 集成 JWT 认证和数据加密
+- ⚡ **流畅体验** - 基于 Jetpack Compose 的响应式界面
+
+### 技术亮点
+- 🚀 **高性能架构** - 使用 Kotlin 协程和现代异步编程
+- 🌐 **网络通信** - 集成 OkHttp 和 Moshi 进行高效数据传输
+- 📦 **模块化设计** - 清晰的代码结构和组件分离
+- 🔧 **开发友好** - 完整的调试工具和测试覆盖
+
+## 🛠 技术栈
+
+<div align="center">
+
+| 类别 | 技术 |
+|------|------|
+| **语言** | Kotlin |
+| **框架** | Android Jetpack, Jetpack Compose |
+| **网络** | OkHttp, Retrofit |
+| **JSON** | Moshi, Gson |
+| **安全** | JWT, Nimbus JOSE JWT |
+| **异步** | Kotlin Coroutines |
+| **UI** | Material Design 3, Compose |
+| **构建** | Gradle Kotlin DSL |
+
+</div>
+
+## 📋 系统要求
+
+- **最低 Android 版本**: Android 9.0 (API Level 28)
+- **目标 Android 版本**: Android 14 (API Level 34)
+- **开发环境**: Android Studio 
+- **构建工具**: Gradle 8.4+
+- **JDK 版本**: Java 8+
+
+## 🚀 快速开始
+
+### 克隆项目
+```bash
+git clone http://124.223.26.33:3000/xiaji/flomo-ai.git
+cd flomo-ai
+```
+
+### 构建项目
+```bash
+# 清理并构建
+./gradlew clean build
+
+# 构建 Debug 版本
+./gradlew assembleDebug
+
+# 构建 Release 版本
+./gradlew assembleRelease
+```
+
+### 运行应用
+```bash
+# 连接设备后安装
+./gradlew installDebug
+```
+
+## 📁 项目结构
+
+```
+flomo-ai/
+├── app/
+│   ├── src/
+│   │   ├── main/
+│   │   │   ├── java/com/example/flomo_ai/
+│   │   │   │   ├── MainActivity.kt      # 主界面
+│   │   │   │   ├── SecondActivity.kt    # 配置界面
+│   │   │   │   ├── kwt.kt              # 工具类
+│   │   │   │   └── ui/                 # UI 组件
+│   │   │   ├── res/                    # 资源文件
+│   │   │   └── AndroidManifest.xml     # 应用配置
+│   └── build.gradle.kts               # 模块构建配置
+├── gradle/                            # Gradle 配置
+├── build.gradle.kts                   # 项目构建配置
+└── README.md                          # 项目说明文档
+```
+
+## 🔧 配置说明
+
+### Gradle 配置优化
+项目已配置国内镜像源以提升构建速度：
+
+```properties
+# gradle.properties
+org.gradle.wrapper.downloadUrl=https://mirrors.aliyun.com/macports/distfiles/gradle/
+org.gradle.internal.http.connectionTimeout=120000
+org.gradle.internal.http.socketTimeout=120000
+```
+
+### 权限说明
+应用需要以下权限：
+- `INTERNET`: 网络通信
+- `READ_EXTERNAL_STORAGE`: 读取外部存储（用于背景图片）
+
+## 📸 应用截图
+
+<table>
+  <tr>
+    <td><img src="Screenshot_20240922_111050.png" width="200"/></td>
+    <td><img src="Screenshot_20240922_214948.png" width="200"/></td>
+    <td><img src="Screenshot_20241001_222239_配置页面修改.png" width="200"/></td>
+  </tr>
+  <tr>
+    <td align="center">主界面</td>
+    <td align="center">笔记页面</td>
+    <td align="center">配置界面</td>
+  </tr>
+</table>
+
+## 🤝 贡献指南
+
+欢迎提交 Issue 和 Pull Request 来改进项目！
+
+### 开发流程
+1. Fork 项目
+2. 创建功能分支 (`git checkout -b feature/AmazingFeature`)
+3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)
+4. 推送到分支 (`git push origin feature/AmazingFeature`)
+5. 开启 Pull Request
+
+## 📄 许可证
+
+本项目采用 MIT 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情
+
+## 📞 联系方式
+
+- 项目地址: `http://124.223.26.33:3000/xiaji/flomo-ai.git`
+- 开发者: xiaji
+
+---
+
+<p align="center">Made with ❤️ for Android developers</p>