Create README-zh.md

This commit is contained in:
Ash 2022-03-20 17:35:57 +08:00
parent 51c6073c96
commit d78d676265
1 changed files with 61 additions and 0 deletions

61
README-zh.md Normal file
View File

@ -0,0 +1,61 @@
[English by DeepL](https://github.com/Ashinch/ReadYou/blob/main/README.md) | 简体中文
# Read You
[Telegram 频道](https://t.me/ReadYouApp) | [Figma 设计稿](https://www.figma.com/file/ViBW8GbUgkTMmK6a80h8X1/Reader-You?node-id=7028%3A23673) | [项目进度](https://github.com/Ashinch/ReadYou/projects/1)
这是一个在 Android 上的 [Reeder](https://reederapp.com/) 仿制品,为了让 Android 拥有一个与 Reeder 相似的 RSS 阅读器。
## 特性
**Read You** 结合了 Reeder 的交互逻辑与 [Material Design 3 (You)](https://m3.material.io/) 的设计风格。
以下是目前取得的进展和近期将要努力的目标:
- [x] 本地
- [x] 订阅 Feed 链接
- [x] 导入 OPML 文件
- [x] 文章同步
- [x] 文章更新通知
- [x] 全文解析
- [x] 过滤未读、星标
- [x] Feed 分组
- [ ] 文章搜索
- [ ] 偏好设置
- [ ] 本地化
- [ ] 发布 APK
- [ ] 小组件
- [ ] ...
- [ ] Fever API 支持
- [ ] Google Reader API 支持
- [ ] Inoreader API 支持
- [ ] ...
> 以上特性仅是初步实现,可能存在某些未知 BUG仍需进行测试和优化。
## 构建
> 如果你想要预览 Read You 应用,可以在 [Telegram 频道](https://t.me/ReadYouApp) 中获取 **预览版本** 的 APK 文件。
**Read You** 基于 Android 原生的 [Jetpack Compose](https://developer.android.com/jetpack/compose) 架构实现。
1. 首先需要获取 **Read You** 的源代码:
```shell
git clone https://github.com/Ashinch/ReadYou.git
```
2. 然后通过 [Android Studio (最新版本)](https://developer.android.com/studio) 打开。
3. 点击 `▶ 运行Run` 按钮后将会自动构建并运行。
> 如遇卡顿现象,请选择 Release 版本构建。
## 依赖
- [MusicYou](https://github.com/Kyant0/MusicYou)
- [ParseRSS](https://github.com/muhrifqii/ParseRSS)
- [Readability4J](https://github.com/dankito/Readability4J)
- (待完善)