初步敲定一个readme,后续继续推进功能性设计,直到认为功能基本达成了,readme再继续设计完善

This commit is contained in:
2026-08-26 22:17:39 +08:00
parent 8f3f827429
commit 055df89ca5
2 changed files with 729 additions and 11 deletions
+43 -11
View File
@@ -1,17 +1,49 @@
# qt_player
# 清听 QingTing
A new Flutter project.
[![Flutter](https://img.shields.io/badge/Flutter-3.x-blue)](https://flutter.dev)
[![Platform](https://img.shields.io/badge/Platform-Android-green)](https://android.com)
## Getting Started
**让远程音乐,像本地音乐一样可靠。**
This project is a starting point for a Flutter application.
清听是一个面向 Android 的 WebDAV 音乐播放器。
A few resources to get you started if this is your first Flutter project:
它解决的事情很简单:
- [Learn Flutter](https://docs.flutter.dev/get-started/learn-flutter)
- [Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
- [Flutter learning resources](https://docs.flutter.dev/reference/learning-resources)
> **让存储在 WebDAV 服务器上的音频文件,获得稳定、连续、可控的本地级播放体验。**
For help getting started with Flutter development, view the
[online documentation](https://docs.flutter.dev/), which offers tutorials,
samples, guidance on mobile development, and a full API reference.
## ✨ 能力
- WebDAV 流式播放,无需下载
- 后台播放,退出应用不停
- 通知中心、锁屏、耳机控制
- 元数据读取与 SQLite 缓存
- 通知栏封面图
## 🚀 快速开始
```bash
# 克隆
git clone https://your-repo/qingting.git
cd qingting
# 获取依赖
flutter pub get
# 运行
flutter run
```
详细步骤:[Getting Started →](./docs/getting-started.md)
## 📖 文档
- [整体架构](./docs/architecture.md) —— 系统怎么组织的
- [播放链路](./docs/playback.md) —— 一首歌从点击到喇叭
- [元数据](./docs/metadata.md) —— 歌曲信息怎么被认识
- [Android 集成](./docs/android.md) —— 怎么成为 Android 播放器
- [存储策略](./docs/storage.md) —— 远程与本地如何共存
- [设计决策](./docs/decisions.md) —— 为什么选了这些方案
---
> 最好的播放器,是当你开始听歌之后,就再也感觉不到它技术细节的那一个。