Skip to content

Commit

Permalink
docs: update README.md and metadata
Browse files Browse the repository at this point in the history
  • Loading branch information
mumu-lhl committed Jan 23, 2025
1 parent 0c53e67 commit 50316d1
Show file tree
Hide file tree
Showing 11 changed files with 8 additions and 20 deletions.
10 changes: 2 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,16 @@ A mdict dictionary with Android support
## Features

* 📄 Support MDX/MDD
* 🔍 Support multiple dictionaries search and display
* 🎨 Support Material You
* 🔈 Support reading aloud
* 🔖 Bookmarking words to the word book
* 📙 Add multiple dictionaries and switch between them

## Screenshots

|||||
|--|--|--|--|
| <img alt="Home" src="./metadata/en-US/images/phoneScreenshots/1.png"> | <img alt="Settings" src="./metadata/en-US/images/phoneScreenshots/2.png"> | <img alt="Manage dictionaries" src="./metadata/en-US/images/phoneScreenshots/3.png"> | <img alt="Search Words" src="./metadata/en-US/images/phoneScreenshots/4.png"> |
| <img alt="Home" src="./metadata/en-US/images/phoneScreenshots/1.png"> | <img alt="Settings" src="./metadata/en-US/images/phoneScreenshots/2.png"> | <img alt="Manage dictionaries" src="./metadata/en-US/images/phoneScreenshots/3.png"> | <img alt="Display Word" src="./metadata/en-US/images/phoneScreenshots/4.png"> |

## Install

Expand All @@ -41,12 +41,6 @@ See [Wiki](https://github.com/mumu-lhl/Ciyue/wiki#recommended-dictionaries).

Ciyue uses WebView to display words in a dictionary, and WebView needs INTERNET permission to work, even if when displaying local data.

### READ_EXTERNAL_STORAGE / MANAGE_EXTERNAL_STORAGE (Manage External Storage)

**Will be removed in v1**

Ciyue needs the permission to read mdd file, which is the resources of mdx file. (such as images, JavaScript, CSS, etc.)

## Translation

You can visit [Weblate](https://hosted.weblate.org/engage/ciyue/) to add languages or fill in translations.
Expand Down
10 changes: 2 additions & 8 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,16 @@
## 特点

* 📄 支持 MDX/MDD
* 🔍 支持多词典搜索和显示
* 🎨 支持 Material You
* 🔈 支持朗读
* 🔖 收藏单词到单词本
* 📙 添加多个词典并在它们之间切换

## 截图

|||||
|--|--|--|--|
| <img alt="主页" src="./metadata/en-US/images/phoneScreenshots/1.png"> | <img alt="设置" src="./metadata/en-US/images/phoneScreenshots/2.png"> | <img alt="管理词典" src="./metadata/en-US/images/phoneScreenshots/3.png"> | <img alt="单词搜索" src="./metadata/en-US/images/phoneScreenshots/4.png"> |
| <img alt="主页" src="./metadata/en-US/images/phoneScreenshots/1.png"> | <img alt="设置" src="./metadata/en-US/images/phoneScreenshots/2.png"> | <img alt="管理词典" src="./metadata/en-US/images/phoneScreenshots/3.png"> | <img alt="单词显示" src="./metadata/en-US/images/phoneScreenshots/4.png"> |

## 安装

Expand All @@ -41,12 +41,6 @@

词悦使用 WebView 显示单词,WebView 即使显示本地数据也需要 INTERNET 权限才能正常工作。

### READ_EXTERNAL_STORAGE / MANAGE_EXTERNAL_STORAGE(管理外部存储空间)

**将在 V1 版本中被移除**

词悦需要该权限去读取 mdd 文件(mdx 文件的资源)。(如图片、JavaScript、CSS 等)。

## 翻译

您可以到 [Weblate](https://hosted.weblate.org/engage/ciyue/) 添加语言或补齐翻译。
Expand Down
2 changes: 1 addition & 1 deletion metadata/en-US/full_description.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Ciyue is a simple mdict dictionary.
Features:

* 📄 Support MDX/MDD
* 🔍 Support multiple dictionaries search and display
* 🎨 Support Material You
* 🔈 Support reading aloud
* 🔖 Bookmarking words to the word book
* 📙 Add multiple dictionaries and switch between them
Binary file modified metadata/en-US/images/icon.png
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 metadata/en-US/images/phoneScreenshots/1.png
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 metadata/en-US/images/phoneScreenshots/2.png
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 metadata/en-US/images/phoneScreenshots/3.png
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 metadata/en-US/images/phoneScreenshots/4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion metadata/zh-CN/full_description.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
特点:

* 📄 支持 MDX/MDD
* 🔍 支持多词典搜索和显示
* 🎨 支持 Material You
* 🔈 支持朗读
* 🔖 收藏单词到单词本
* 📙 添加多个词典并在它们之间切换
2 changes: 1 addition & 1 deletion metadata/zh-HK/full_description.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
特點:

* 📄 支持 MDX/MDD
* 🔍 支持多詞典搜索和顯示
* 🎨 支持 Material You
* 🔈 支持朗讀
* 🔖 收藏單詞到單詞本
* 📙 添加多個詞典並在它們之間切換
2 changes: 1 addition & 1 deletion metadata/zh-TW/full_description.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
特點:

* 📄 支持 MDX/MDD
* 🔍 支持多字典搜尋和顯示
* 🎨 支持 Material You
* 🔈 支持朗讀
* 🔖 收藏單詞到單詞本
* 📙 添加多個詞典並在它們之間切換

0 comments on commit 50316d1

Please sign in to comment.