ReadYou/README-zh-CN.md

101 lines
4.4 KiB
Markdown
Raw Normal View History

2022-04-10 17:30:21 +02:00
<div align="center">
2022-04-28 19:43:01 +02:00
<img width="200" height="200" style="display: block; border: 1px solid #f5f5f5; border-radius: 9999px;" src="./fastlane/metadata/android/en-US/images/icon.png">
2022-04-10 17:30:21 +02:00
</div>
<br>
<br>
<br>
<div align="center">
<img alt="GitHub" src="https://img.shields.io/github/license/Ashinch/ReadYou?color=c3e7ff&style=flat-square">
<img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/Ashinch/ReadYou?color=c3e7ff&style=flat-square">
<img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/Ashinch/ReadYou?color=c3e7ff&style=flat-square">
<br>
<a target="_blank" href="https://t.me/ReadYouApp">
<img alt="Telegram" src="https://img.shields.io/badge/Telegram-ReadYouApp-c3e7ff?logo=telegram&style=flat-square">
</a>
<a target="_blank" href="https://www.figma.com/file/ViBW8GbUgkTMmK6a80h8X1/Read-You?node-id=7028%3A23673">
<img alt="Figma" src="https://img.shields.io/badge/Figma-ReadYou-c3e7ff?logo=figma&style=flat-square">
</a>
</div>
<div align="center">
<h1>Read You</h1>
<p>这是一个在 Android 上的 <a href="https://reederapp.com/">Reeder</a> 仿制品,为了让 Android 拥有一个与 Reeder 相似的 RSS 阅读器。</p>
<p><a target="_blank" href="https://github.com/Ashinch/ReadYou/blob/main/README.md">English by DeepL</a>&nbsp;&nbsp;|&nbsp;&nbsp;
2022-05-15 22:28:32 +02:00
<a target="_blank" href="https://github.com/Ashinch/ReadYou/blob/main/README-de.md">Deutsch</a>&nbsp;&nbsp;|&nbsp;&nbsp;
简体中文</p>&nbsp;&nbsp;|&nbsp;&nbsp;
<a target="_blank" href="https://github.com/Ashinch/ReadYou/blob/main/README-zh-TW.md">繁體中文</a></p>
2022-04-10 19:07:39 +02:00
<br/>
<br/>
2022-04-27 21:42:08 +02:00
<img src="./fastlane/metadata/android/zh/images/startup.png" width="19.2%" alt="startup" />
<img src="./fastlane/metadata/android/zh/images/feeds.png" width="19.2%" alt="startup" />
<img src="./fastlane/metadata/android/zh/images/flow.png" width="19.2%" alt="startup" />
<img src="./fastlane/metadata/android/zh/images/read.png" width="19.2%" alt="startup" />
<img src="./fastlane/metadata/android/zh/images/settings.png" width="19.2%" alt="startup" />
2022-04-10 19:07:39 +02:00
<br/>
<br/>
2022-04-10 17:30:21 +02:00
</div>
2022-03-20 10:35:57 +01:00
## 特性
**Read You** 结合了 Reeder 的交互逻辑与 [Material Design 3 (You)](https://m3.material.io/) 的设计风格。
以下是目前取得的进展和近期将要努力的目标:
- [x] 本地
2022-03-30 12:12:09 +02:00
- [x] 订阅 RSS 链接
2022-03-20 10:35:57 +01:00
- [x] 导入 OPML 文件
- [x] 文章同步
- [x] 文章更新通知
- [x] 全文解析
- [x] 过滤未读、星标
2022-03-30 12:12:09 +02:00
- [x] 订阅源分组
2022-03-20 17:07:45 +01:00
- [x] 本地化
2022-03-30 12:12:09 +02:00
- [x] 导出 OPML 文件
2022-04-10 17:30:21 +02:00
- [x] 文章搜索
2022-03-20 10:35:57 +01:00
- [ ] 偏好设置
- [ ] 发布 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 版本构建。
2022-04-27 21:42:08 +02:00
## 感谢开源
2022-03-20 10:35:57 +01:00
- [MusicYou](https://github.com/Kyant0/MusicYou)
2022-03-30 12:12:09 +02:00
- [ParseRSS](https://github.com/muhrifqii/ParseRSS): [MIT](https://github.com/muhrifqii/ParseRSS/blob/master/LICENSE)
- [Readability4J](https://github.com/dankito/Readability4J): [Apache License 2.0](https://github.com/dankito/Readability4J/blob/master/LICENSE)
- [opml-parser](https://github.com/mdewilde/opml-parser): [Apache License 2.0](https://github.com/mdewilde/opml-parser/blob/master/LICENSE)
2022-04-10 17:30:21 +02:00
- [compose-html](https://github.com/ireward/compose-html): [Apache License 2.0](https://github.com/ireward/compose-html/blob/main/LICENSE.txt)
- [Rome](https://github.com/rometools/rome): [Apache License 2.0](https://github.com/rometools/rome/blob/master/LICENSE)
- [Feeder](https://gitlab.com/spacecowboy/Feeder): [GPL v3.0](https://gitlab.com/spacecowboy/Feeder/-/blob/master/LICENSE)
2022-03-30 17:34:22 +02:00
## 许可证
[GNU GPL v3.0](https://github.com/Ashinch/ReadYou/blob/main/LICENSE)