Skip to content

Commit

Permalink
[doc] Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
SkyD666 committed May 20, 2024
1 parent a50eebb commit e952907
Show file tree
Hide file tree
Showing 30 changed files with 25 additions and 11 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
</a>
</p>
<p>
<b>AniVu</b>, an <b>all-in-one tool</b> for <b>RSS anime subscription and updates</b>, <b>bit torrent downloads</b>, and <b>video playback</b>.
<b>AniVu</b>, an <b>all-in-one tool</b> for <b>RSS subscription and updates</b>, <b>bit torrent downloads</b>, and <b>video playback</b>.
</p>
<p>
AniVu utilizes the <b><a href="https://developer.android.com/topic/architecture#recommended-app-arch">MVI</a></b> architecture and fully adopts the <b><a href="https://m3.material.io/">Material You</a></b> design style. All pages are developed using <b>Android View</b> and <b>Jetpack Compose</b>.
Expand All @@ -38,6 +38,7 @@
</div>



## 💡 Features

1. **Subscribe to RSS**, Update RSS, **Read** RSS
Expand Down Expand Up @@ -65,8 +66,9 @@
<img src="doc/image/en/ic_rss_fragment.jpg" alt="ic_rss_fragment" style="zoom:80%;" /> <img src="doc/image/en/ic_media_fragment.jpg" alt="ic_media_fragment" style="zoom:80%;" />
<img src="doc/image/en/ic_article_fragment.jpg" alt="ic_article_fragment" style="zoom:80%;" /> <img src="doc/image/en/ic_read_fragment.jpg" alt="ic_read_fragment" style="zoom:80%;" />
<img src="doc/image/en/ic_read_fragment_enclosure.jpg" alt="ic_read_fragment_enclosure" style="zoom:80%;" /> <img src="doc/image/en/ic_download_fragment.jpg" alt="ic_download_fragment" style="zoom:80%;" />
<img src="doc/image/en/ic_setting_fragment.jpg" alt="ic_setting_fragment" style="zoom:80%;" /> <img src="doc/image/en/ic_appearance_fragment.jpg" alt="ic_appearance_fragment" style="zoom:80%;" />
<img src="doc/image/en/ic_rss_config_fragment.jpg" alt="ic_rss_config_fragment" style="zoom:80%;" /> <img src="doc/image/en/ic_about_fragment.jpg" alt="ic_about_fragment" style="zoom:80%;" />
<img src="doc/image/en/ic_player_activity.png" alt="ic_player_activity" style="zoom:80%;" />
<img src="doc/image/en/ic_player_activity.jpg" alt="ic_player_activity" style="zoom:80%;" />

## 🌏 Translation

Expand All @@ -91,7 +93,11 @@ If you are interested, please help us **translate**, thank you.
- Navigation
- Coil

## ✨ Other works
## ✨ Star History

[![Star History Chart](https://api.star-history.com/svg?repos=SkyD666/AniVu)](https://star-history.com/?repos=SkyD666/AniVu#SkyD666/AniVu&Date)

## 🎈 Other works

<table>
<thead>
Expand Down
Binary file added doc/image/en/ic_appearance_fragment.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/image/en/ic_article_fragment.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/image/en/ic_media_fragment.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/image/en/ic_player_activity.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed doc/image/en/ic_player_activity.png
Binary file not shown.
Binary file modified doc/image/en/ic_read_fragment.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/image/en/ic_read_fragment_enclosure.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/image/en/ic_rss_fragment.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/image/en/ic_setting_fragment.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/image/zh-rCN/ic_appearance_fragment.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/image/zh-rCN/ic_article_fragment.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/image/zh-rCN/ic_media_fragment.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/image/zh-rCN/ic_player_activity.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed doc/image/zh-rCN/ic_player_activity.png
Binary file not shown.
Binary file modified doc/image/zh-rCN/ic_read_fragment.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/image/zh-rCN/ic_read_fragment_enclosure.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/image/zh-rCN/ic_rss_fragment.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/image/zh-rCN/ic_setting_fragment.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/image/zh-rTW/ic_appearance_fragment.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/image/zh-rTW/ic_article_fragment.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/image/zh-rTW/ic_media_fragment.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/image/zh-rTW/ic_player_activity.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed doc/image/zh-rTW/ic_player_activity.png
Binary file not shown.
Binary file modified doc/image/zh-rTW/ic_read_fragment.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/image/zh-rTW/ic_read_fragment_enclosure.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/image/zh-rTW/ic_rss_fragment.jpg
Binary file added doc/image/zh-rTW/ic_setting_fragment.jpg
12 changes: 8 additions & 4 deletions doc/readme/README-zh-rCN.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
</a>
</p>
<p>
<b>AniVu</b>,一个集<b> RSS 番剧订阅与更新、比特洪流下载、视频播放</b>为一体的工具。
<b>AniVu</b>,一个集<b> RSS 订阅与更新、比特洪流下载、视频播放</b>为一体的工具。
</p>
<p>
使用 <b><a href="https://developer.android.com/topic/architecture#recommended-app-arch">MVI</a></b> 架构,完全采用 <b><a href="https://m3.material.io/">Material You</a></b> 设计风格。使用 <b>Android View</b> 和 <b>Jetpack Compose</b> 混合开发。
Expand All @@ -35,7 +35,6 @@
</div>



## 💡主要功能

1. **订阅** RSS、**更新** RSS、**阅读** RSS
Expand Down Expand Up @@ -63,8 +62,9 @@
<img src="../image/zh-rCN/ic_rss_fragment.jpg" alt="ic_rss_fragment" style="zoom:80%;" /> <img src="../image/zh-rCN/ic_media_fragment.jpg" alt="ic_media_fragment" style="zoom:80%;" />
<img src="../image/zh-rCN/ic_article_fragment.jpg" alt="ic_article_fragment" style="zoom:80%;" /> <img src="../image/zh-rCN/ic_read_fragment.jpg" alt="ic_read_fragment" style="zoom:80%;" />
<img src="../image/zh-rCN/ic_read_fragment_enclosure.jpg" alt="ic_read_fragment_enclosure" style="zoom:80%;" /> <img src="../image/zh-rCN/ic_download_fragment.jpg" alt="ic_download_fragment" style="zoom:80%;" />
<img src="../image/zh-rCN/ic_setting_fragment.jpg" alt="ic_setting_fragment" style="zoom:80%;" /> <img src="../image/zh-rCN/ic_appearance_fragment.jpg" alt="ic_appearance_fragment" style="zoom:80%;" />
<img src="../image/zh-rCN/ic_rss_config_fragment.jpg" alt="ic_rss_config_fragment" style="zoom:80%;" /> <img src="../image/zh-rCN/ic_about_fragment.jpg" alt="ic_about_fragment" style="zoom:80%;" />
<img src="../image/zh-rCN/ic_player_activity.png" alt="ic_player_activity" style="zoom:80%;" />
<img src="../image/zh-rCN/ic_player_activity.jpg" alt="ic_player_activity" style="zoom:80%;" />

## 🌏翻译

Expand All @@ -89,7 +89,11 @@
- Navigation
- Coil

## ✨其他应用
## ✨Star History

[![Star History Chart](https://api.star-history.com/svg?repos=SkyD666/AniVu)](https://star-history.com/?repos=SkyD666/AniVu#SkyD666/AniVu&Date)

## 🎈其他应用

<table>
<thead>
Expand Down
12 changes: 8 additions & 4 deletions doc/readme/README-zh-rTW.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
</a>
</p>
<p>
<b>AniVu</b>,一個集<b> RSS 番劇訂閱與更新、BitTorrent下載、影片播放</b>為一體的工具。
<b>AniVu</b>,一個集<b> RSS 訂閱與更新、BitTorrent下載、影片播放</b>為一體的工具。
</p>
<p>
使用 <b><a href="https://developer.android.com/topic/architecture#recommended-app-arch">MVI</a></b> 架構,完全採用 <b><a href="https://m3.material.io/">Material You</a></b> 設計風格。使用 <b>Android View</b> 和 <b>Jetpack Compose</b> 混合開發。
Expand All @@ -35,7 +35,6 @@
</div>



## 💡主要功能

1. **訂閱** RSS、**更新** RSS、**閱讀** RSS
Expand Down Expand Up @@ -63,8 +62,9 @@
<img src="../image/zh-rTW/ic_rss_fragment.jpg" alt="ic_rss_fragment" style="zoom:80%;" /> <img src="../image/zh-rTW/ic_media_fragment.jpg" alt="ic_media_fragment" style="zoom:80%;" />
<img src="../image/zh-rTW/ic_article_fragment.jpg" alt="ic_article_fragment" style="zoom:80%;" /> <img src="../image/zh-rTW/ic_read_fragment.jpg" alt="ic_read_fragment" style="zoom:80%;" />
<img src="../image/zh-rTW/ic_read_fragment_enclosure.jpg" alt="ic_read_fragment_enclosure" style="zoom:80%;" /> <img src="../image/zh-rTW/ic_download_fragment.jpg" alt="ic_download_fragment" style="zoom:80%;" />
<img src="../image/zh-rTW/ic_setting_fragment.jpg" alt="ic_setting_fragment" style="zoom:80%;" /> <img src="../image/zh-rTW/ic_appearance_fragment.jpg" alt="ic_appearance_fragment" style="zoom:80%;" />
<img src="../image/zh-rTW/ic_rss_config_fragment.jpg" alt="ic_rss_config_fragment" style="zoom:80%;" /> <img src="../image/zh-rTW/ic_about_fragment.jpg" alt="ic_about_fragment" style="zoom:80%;" />
<img src="../image/zh-rTW/ic_player_activity.png" alt="ic_player_activity" style="zoom:80%;" />
<img src="../image/zh-rTW/ic_player_activity.jpg" alt="ic_player_activity" style="zoom:80%;" />

## 🌏翻譯

Expand All @@ -89,7 +89,11 @@
- Navigation
- Coil

## ✨其他應用
## ✨Star History

[![Star History Chart](https://api.star-history.com/svg?repos=SkyD666/AniVu)](https://star-history.com/?repos=SkyD666/AniVu#SkyD666/AniVu&Date)

## 🎈其他應用

<table>
<thead>
Expand Down

0 comments on commit e952907

Please sign in to comment.