Update README.md

This commit is contained in:
Ash 2022-03-20 17:35:17 +08:00
parent f4828ac01a
commit 51c6073c96

View File

@ -1,55 +1,61 @@
# Reader English by DeepL | [简体中文](https://github.com/Ashinch/ReadYou/blob/main/README-zh.md)
这是一个在 Android 上的 [Reeder](https://reederapp.com/) 仿制品,为了让 Android 拥有一个与 Reeder 相似的 RSS 阅读器。 # Read You
## 特性 [Telegram](https://t.me/ReadYouApp) | [Figma](https://www.figma.com/file/ViBW8GbUgkTMmK6a80h8X1/Reader-You?node-id=7028%3A23673) | [Project Schedule](https://github.com/Ashinch/ReadYou/projects/1)
本项目依照 Reeder 的用户界面和交互逻辑,融入动态色彩等来自 Material 3 (You) 的新特性。 This is a [Reeder](https://reederapp.com/) copycat, in order to give Android an RSS reader similar to Reeder.
以下是目前取得的进展和近期将要努力的目标: ## Features
- [x] 本地 **Read You** combines the interaction logic of Reeder with the design style of [Material Design 3 (You)](https://m3.material.io/).
- [x] [Figma 文件](https://www.figma.com/file/ViBW8GbUgkTMmK6a80h8X1/Reader-You?node-id=7028%3A23673)
- [x] 订阅 Feed 链接 The following are the progress made so far and the goals to be worked on in the near future:
- [x] 导入 OPML 文件
- [x] 文章同步 - [x] Local
- [x] 文章更新通知
- [x] 全文解析 - [x] Subscribe to Feed Links
- [x] 过滤已读、未读、星标 - [x] Import from OPML
- [ ] 文章搜索 - [x] Article Sync
- [ ] Feed 分组 - [x] Article Update Notification
- [ ] 设置相关 - [x] Full Content Parsing
- [ ] 小组件 - [x] Filter unread and starred
- [x] Feed Grouping
- [ ] Search for articles
- [ ] Preference settings
- [ ] Localization
- [ ] Release APK
- [ ] Widget
- [ ] ... - [ ] ...
- [ ] FreshRSS API 支持 - [ ] Fever API Support
- [ ] 发布 APK - [ ] Google Reader API Support
- [ ] Inoreader API 支持 - [ ] Inoreader API Support
- [ ] ... - [ ] ...
[看板视图](https://github.com/Ashinch/Reader/projects/1)中记录了更详细的项目进展。 > The above features are only preliminary implementations and there may be unknown issues.
> 以上特性仅是初步实现,可能存在某些未知 BUG仍需进行测试和优化。 ## Build
## 构建 > If you want to preview the Read You app, you can get the **preview version** of the APK file in [Telegram](https://t.me/ReadYouApp).
本项目基于 Android 原生的 Jetpack Compose 架构实现。目前处于开发阶段,所以暂未发布 APK。 **Read You** is implemented on Android's native [Jetpack Compose](https://developer.android.com/jetpack/compose) architecture.
1. 如果你想要预览该应用,首先需要获取本项目的源代码: 1. First you need to get the source code of **Read You**.
```shell ```shell
git clone https://github.com/Ashinch/Reader.git git clone https://github.com/Ashinch/ReadYou.git
``` ```
2. 然后通过 [Android Studio (最新版本)](https://developer.android.com/studio) 打开。 2. Then open it via [Android Studio (latest version)](https://developer.android.com/studio).
3. 点击 `▶ 运行Run` 按钮后将会自动构建并运行。 3. When you click the `▶ Run` button, it will be built and run automatically.
> 如遇卡顿现象,请选择 Release 版本构建。 > In case of lag, please select Release version build.
## Credit ## Credits
- [MusicYou](https://github.com/Kyant0/MusicYou) - [MusicYou](https://github.com/Kyant0/MusicYou)
- [ParseRSS](https://github.com/muhrifqii/ParseRSS) - [ParseRSS](https://github.com/muhrifqii/ParseRSS)
- [Readability4J](https://github.com/dankito/Readability4J) - [Readability4J](https://github.com/dankito/Readability4J)
- 待完善 - To be improved