ReadYou/README-zh-CN.md

161 lines
7.5 KiB
Markdown
Raw Permalink Normal View History

2022-04-10 17:30:21 +02:00
<div align="center">
2024-01-22 10:46:11 +01:00
<img width="200" height="200" style="display: block; border: 1px solid #f5f5f5; border-radius: 9999px;" src="https://raw.githubusercontent.com/Ashinch/ReadYou/main/fastlane/metadata/android/zh-CN/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">
2022-08-08 16:53:48 +02:00
<a target="_blank" href="https://github.com/Ashinch/ReadYou/releases">
<img alt="Version" src="https://img.shields.io/github/v/release/Ashinch/ReadYou?color=c3e7ff&label=version&style=flat-square">
</a>
2022-04-10 17:30:21 +02:00
<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>
2023-01-12 13:26:36 +01:00
<p>一个以 <a target="_blank" href="https://m3.material.io/">Material You</a> 风格呈现的 Android RSS 阅读器。</p>
<a target="_blank" href="https://github.com/Ashinch/ReadYou/blob/main/README.md">English</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;
2023-01-12 13:26:36 +01:00
简体中文&nbsp;&nbsp;|&nbsp;&nbsp;
2022-08-09 15:07:28 +02:00
<a target="_blank" href="https://github.com/Ashinch/ReadYou/blob/main/README-zh-TW.md">繁體中文</a>&nbsp;&nbsp;|&nbsp;&nbsp;
<a target="_blank" href="https://github.com/Ashinch/ReadYou/blob/main/README-fa.md">فارسی</a></p>
2022-04-10 19:07:39 +02:00
<br/>
<br/>
2024-01-22 10:46:11 +01:00
<img src="https://raw.githubusercontent.com/Ashinch/ReadYou/main/fastlane/metadata/android/zh-CN/images/phoneScreenshots/startup.png" width="19.2%"alt="startup" />
<img src="https://raw.githubusercontent.com/Ashinch/ReadYou/main/fastlane/metadata/android/zh-CN/images/phoneScreenshots/feeds.png" width="19.2%" alt="feeds" />
<img src="https://raw.githubusercontent.com/Ashinch/ReadYou/main/fastlane/metadata/android/zh-CN/images/phoneScreenshots/flow.png" width="19.2%" alt="flow" />
<img src="https://raw.githubusercontent.com/Ashinch/ReadYou/main/fastlane/metadata/android/zh-CN/images/phoneScreenshots/read.png" width="19.2%" alt="read" />
<img src="https://raw.githubusercontent.com/Ashinch/ReadYou/main/fastlane/metadata/android/zh-CN/images/phoneScreenshots/settings.png" width="19.2%" alt="settings" />
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
## 特性
2023-01-12 13:26:36 +01:00
**Read You** 是一个以 [Material You](https://m3.material.io/) 风格呈现的 Android RSS 阅读器,这些是目前已完成的功能和未来要做的事。
- [x] 订阅 RSS 链接
- [x] 导入 / 导出 OPML 文件
- [x] 新文章通知
- [x] 可读性优化(截取文章正文内容)
2023-01-12 13:26:36 +01:00
- [x] 全文解析
- [x] 支持多账户
- [ ] 仿生阅读
- [ ] 大声朗读
- [ ] Android 微件 / 小组件
- [ ] ...
## 集成
**Read You** 也集成了一些第三方服务 API支持您使用已有的云端账户来作为数据源。
- [x] Fever
- [x] Google Reader
- [x] FreshRSS
2023-01-12 13:26:36 +01:00
- [ ] Miniflux
- [ ] Tiny Tiny RSS
- [ ] Inoreader
- [ ] Feedly
- [ ] Feedbin
- [ ] ...
2022-03-20 10:35:57 +01:00
2023-01-12 13:26:36 +01:00
## 下载
2022-03-20 10:35:57 +01:00
2023-01-12 13:26:36 +01:00
[<img src="https://s1.ax1x.com/2023/01/12/pSu1a36.png" alt="Get it on GitHub" height="80">](https://github.com/Ashinch/ReadYou/releases)
[<img src="https://s1.ax1x.com/2023/01/12/pSnTZ0f.png"
alt="Get it on Telegram Channel"
height="80">](https://t.me/ReadYouApp)
[<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png"
alt="Get it on F-Droid"
height="80">](https://f-droid.org/packages/me.ash.reader/)
2022-03-20 10:35:57 +01:00
2023-01-12 13:26:36 +01:00
F-Droid 版本与其他版本不兼容,您无法通过覆盖安装包来升级、切换至其他版本,需要卸载后再重新安装,届时所有本地数据将被清除。整个应用的编译、签名和分发均由 [F-Droid](https://f-droid.org/docs/FAQ_-_General/) 统一完成。
2022-03-20 10:35:57 +01:00
## 夜间构建
我们提供夜间构建用于测试目的,这些版本包含最新的功能和改进,但可能不如常规版本稳定。请注意,夜间版本可能存在 bug并且不建议日常使用。
<a target="_blank" href="https://github.com/Ashinch/ReadYou/actions/workflows/build_commit.yaml">检查夜间构建</a>
从 GitHub Actions 页面选择最新的 workflow并从该 workflow 的摘要页面下载构建文件(您可能需要登录 GitHub
**在尝试夜间版本之前,请备份好您的数据。**
2023-01-12 13:26:36 +01:00
## 捐赠
2022-03-20 10:35:57 +01:00
2023-01-12 13:26:36 +01:00
**Read You** 是一款免费的自由开源软件,它受益于开源社区,每一位用户都能够免费享受到它完整的功能,如果您赞赏我目前的工作,可以选择请我喝一杯咖啡 ☕️。
2022-03-20 10:35:57 +01:00
2023-01-12 13:26:36 +01:00
[<img src="https://s1.ax1x.com/2023/01/12/pSnHqpQ.png"
alt="donate"
height="80">](https://afdian.net/a/ashinch)
2022-08-08 16:53:48 +02:00
2023-01-12 13:26:36 +01:00
[感谢所有的爱与支持 ❤️](https://afdian.net/a/ashinch?tab=sponsor)
2022-08-08 16:53:48 +02:00
2023-01-12 13:26:36 +01:00
## 本地化
2022-08-08 16:53:48 +02:00
2023-01-12 13:26:36 +01:00
感谢每一位 **Read You** 的翻译人员,如果您也希望做出贡献,请通过 [Weblate](https://hosted.weblate.org/engage/readyou/) 来提交翻译文本。
2022-08-08 16:53:48 +02:00
2023-01-12 13:26:36 +01:00
[<img src="https://hosted.weblate.org/widgets/readyou/-/horizontal-auto.svg" alt="" />](https://hosted.weblate.org/engage/readyou/)
2022-08-08 16:53:48 +02:00
2022-03-20 10:35:57 +01:00
## 构建
2023-01-12 13:26:36 +01:00
> 欢迎 [提交](https://github.com/Ashinch/ReadYou/pulls) 您的代码,[GitHub Actions](https://github.com/Ashinch/ReadYou/actions) 为每次提交都自动打包了所有分发渠道的 APK 文件。
2022-03-20 10:35:57 +01:00
2023-01-12 13:26:36 +01:00
**Read You** 基于 [Jetpack Compose](https://developer.android.com/jetpack/compose) 工具包来构建 Android 原生用户界面。
2022-03-20 10:35:57 +01:00
2023-01-12 13:26:36 +01:00
1. 首先您需要获取 **Read You** 的源代码:
2022-03-20 10:35:57 +01:00
```shell
git clone https://github.com/Ashinch/ReadYou.git
```
2. 然后通过 [Android Studio (最新版本)](https://developer.android.com/studio) 打开。
3. 点击 `▶ 运行Run` 按钮后将会自动构建并运行。
> 如遇卡顿现象,请选择 Release 版本构建。
2023-01-12 13:26:36 +01:00
## 致谢
### 开源项目
- [MusicYou](https://github.com/Kyant0/MusicYou)
- [ParseRSS](https://github.com/muhrifqii/ParseRSS)
- [Readability4J](https://github.com/dankito/Readability4J)
- [opml-parser](https://github.com/mdewilde/opml-parser)
- [compose-html](https://github.com/ireward/compose-html)
- [Rome](https://github.com/rometools/rome)
- [Feeder](https://gitlab.com/spacecowboy/Feeder)
- [Seal](https://github.com/JunkFood02/Seal)
- [news-flash](https://gitlab.com/news-flash)
2023-10-09 11:23:44 +02:00
- [besticon](https://github.com/mat/besticon)
2023-01-12 13:26:36 +01:00
- ...
### 特别鸣谢
2023-01-12 14:03:37 +01:00
[<img src="https://avatars.githubusercontent.com/u/76829190?v=4" width="180" height="180" style="display: block; border: 1px solid #f5f5f5; border-radius: 9999px;"/>](https://github.com/Kyant0)
2023-01-12 13:26:36 +01:00
感谢 **@Kyant0** 为 **Read You** 提供的设计灵感与 Monet 引擎实现。
2023-01-12 13:26:36 +01:00
[<img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png" width="200" alt="Copyright © 2000-2023 JetBrains s.r.o. JetBrains and the JetBrains logo are registered trademarks of JetBrains s.r.o."/>](https://www.jetbrains.com/)
感谢 **JetBrains****Read You** 提供的开源项目产品许可证。
[<img src="https://hosted.weblate.org/widgets/readyou/-/287x66-white.png" width="200"/>](https://hosted.weblate.org/engage/readyou/)
2022-03-20 10:35:57 +01:00
2023-01-12 13:26:36 +01:00
感谢 **Weblate****Read You** 提供的开源项目免费托管服务。
2022-03-30 17:34:22 +02:00
## 许可证
2023-01-12 13:26:36 +01:00
GNU GPL v3.0 © [Read You](https://github.com/Ashinch/ReadYou/blob/main/LICENSE)