diff --git a/English.md b/English.md index 9cc6b9800..fba54ede9 100644 --- a/English.md +++ b/English.md @@ -1,149 +1,116 @@ -# [English](English.md) [中文](README.md) +# Legado with MD3 -[![icon_android](https://github.com/gedoor/gedoor.github.io/blob/master/static/img/legado/icon_android.png)](https://play.google.com/store/apps/details?id=io.legado.play.release) - -idea - -
-legado - -Legado / 开源阅读 -
-gedoor.github.io / legado.top -
-Legado is a free and open source novel reader for Android. -
+

+ 简体中文 | + English +

-[![](https://img.shields.io/badge/-Contents:-696969.svg)](#contents) [![](https://img.shields.io/badge/-Function-F5F5F5.svg)](#Function-) [![](https://img.shields.io/badge/-Download-F5F5F5.svg)](#Download-) [![](https://img.shields.io/badge/-Community-F5F5F5.svg)](#Community-) [![](https://img.shields.io/badge/-API-F5F5F5.svg)](#API-) [![](https://img.shields.io/badge/-Other-F5F5F5.svg)](#Other-) [![](https://img.shields.io/badge/-Grateful-F5F5F5.svg)](#Grateful-) [![](https://img.shields.io/badge/-Interface-F5F5F5.svg)](#Interface-) +--- ->New user? +## 📖 Introduction + +**Legado with MD3** is a Material Design 3–styled refactor based on the open-source project +👉 [Legado (阅读)](https://github.com/gedoor/legado). + +In addition to a visual redesign of the UI, this project introduces multiple branch-specific +features. +It is also gradually migrating from the traditional **View system** to **Jetpack Compose**, aiming +to deliver a more modern, smooth, and consistent reading experience. + +> [!CAUTION] +> **Important Notes** > ->The software does not provide content, you need to add it manually, such as importing book sources, etc. ->Take a look at [official help documentation](https://www.yuque.com/legado/wiki),Maybe there's an answer you need inside. +> Due to the theme system being rebuilt on top of the **Monet engine**, themes from the official +> version are **not compatible** with this fork. +> +> **Devices below Android 12:** +> Custom themes and dynamic color features are currently unavailable. +> This limitation will be addressed after the Jetpack Compose migration is completed. +> (Due to limited developer resources, this process may take a considerable amount of time.) -# Function [![](https://img.shields.io/badge/-Function-F5F5F5.svg)](#Function-) +--- -You can customize the book source, set your own rules, and capture web page data. The rules are simple and easy to understand. There are rules in the software. List bookshelf, grid bookshelf switch freely. The book source rules support search and discovery, and all the functions of finding books and reading books are all customized, making it easier to find books. -* Custom ebook sources, set your own rules to capture web data, the rules are simple and easy to understand, the software has a rule description. -* eBook sources rules support search and discovery, all find books and read books function all custom, find books more convenient. -* Schedule updating your library for new chapters. -* Online reading from web sources that can be imported in bulk -* Local reading of Auto-download episodes. -* Local reading of TXT or EPUB files -* ebook Wishlist -* Big text viewer. You can open eBook and txt in 1GB size -* Automatic text replacement for removing ad in content -* List bookshelf, grid bookshelf free to switch. -* Subscription content, you can subscribe to any content you want to see, see what you want to see -* A configurable reader with fonts, background, page transitions mode and other settings -* Timer. Set interval time to listen ebook, time up, ebook turn off completely. -* TTS book reader. tts can optionally be install“smartvoice-4.1.0” or ”Speech Services by Google“ Give your baby a storybook to listen to and teach your baby to talk, -* Dark mode and E-Ink mode support and Web service support -* Create backups to local or WebDav server -* Decentralization web3 -* Support replacement purification, it is very convenient to remove the content of advertisement replacement. -* Support local TXT, EPUB reading, manual browsing, intelligent scanning. -* Support highly customized reading interface, switch font, color, background, line spacing, paragraph spacing, bold, simplified and traditional conversion. -* Support multiple page turning modes, covering, emulating, sliding, scrolling, etc. +## ✨ Branch Features +Compared to the official version, this project provides the following exclusive features: - - # - +* **New Theme System:** + A fully redesigned Material Design 3 UI, with support for **predictive back gestures** and * + *shared element transitions**. +* **Reading Interface:** + More personalized reading layouts and menu configurations. +* **Reading Records:** + Detailed reading statistics with **timeline** and **chapter-based** views. +* **Enhanced Experience:** + Improved experiences for **comic reading**, **audiobooks**, and **discovery** pages. +* **Bookshelf Layouts:** + More bookshelf layout options, with dedicated UI optimizations for **tablet devices**. +* **Practical Features:** + Added book notes and **smart companion groups** (automatically categorizing read / unread books). -# Download [![](https://img.shields.io/badge/-Download-F5F5F5.svg)](#Download-) +--- -#### Android +## 🛠️ Core Features -* [Releases](https://github.com/gedoor/legado/releases/latest) -* [Google play - $1.99](https://play.google.com/store/apps/details?id=io.legado.play.release) -* [Coolapk](https://www.coolapk.com/apk/io.legado.app.release) -* [\#Beta](https://kunfei.lanzoui.com/b0f810h4b) -* [IzzyOnDroid F-Droid Repository](https://apt.izzysoft.de/fdroid/index/apk/io.legado.app.release) +1. **Custom Book Sources** + A powerful crawling engine with simple and flexible rules for fetching web content. +2. **Multiple Format Support** + Supports local TXT and EPUB files, with automatic local file scanning. +3. **Highly Customizable Reading Experience** + Font, background, line spacing, paragraph spacing, bold text, simplified/traditional Chinese + conversion, and more. +4. **Content Subscription** + Not limited to books — subscribe to any content you want to read. +5. **Content Filtering & Replacement** + Powerful ad removal and content replacement rules. +6. **Page Turning Modes** + Multiple page turning modes including cover, simulation, sliding, and scrolling. +7. **Fully Open Source** + Ad-free and continuously improved. +--- -#### IOS +## 🤝 Community & Support -* Stopped(No release) - [Github](https://github.com/gedoor/YueDuFlutter) +The following communities belong to the **original project**. +Due to limited developer availability, this fork currently does **not** have an independent +community. - - # - +* **Official Wiki:** + [Book Source Rule Tutorial](https://mgz0227.github.io/The-tutorial-of-Legado/) +* **Community Channels:** + [Telegram](https://t.me/legado_channels) | [Discord](https://discord.gg/VtUfRyzRXn) | [Yuque Wiki](https://www.yuque.com/legado/wiki/community) +* **Related Documents:** + [Disclaimer](https://gedoor.github.io/Disclaimer) | [Changelog](https://www.google.com/search?q=/app/src/main/assets/updateLog.md) -# Community [![](https://img.shields.io/badge/-Community-F5F5F5.svg)](#Community-) +--- -#### Telegram +## ❤️ Acknowledgements -[![Telegram-group](https://img.shields.io/badge/Telegram-group-blue)](https://t.me/yueduguanfang) [![Telegram-channel](https://img.shields.io/badge/Telegram-channel-blue)](https://t.me/legado_channels) +Special thanks to the following excellent open-source projects for inspiration and technical +support: -#### Discord +* [gedoor/legado](https://github.com/gedoor/legado) *(the legendary original project)* +* [Luoyacheng/legado](https://github.com/Luoyacheng/legado) *(providing extended features)* +* [komikku-app/komikku](https://github.com/komikku-app/komikku) *(UI inspiration and Compose + components)* +* [FoedusProgramme/Gramophone](https://github.com/FoedusProgramme/Gramophone) *(UI inspiration and + View-based cover color extraction)* +* [jordond/MaterialKolor](https://github.com/jordond/MaterialKolor) *(excellent dynamic color + implementation for Jetpack Compose)* +* [Calvin-LL/Reorderable](https://github.com/Calvin-LL/Reorderable) *(drag-and-drop reordering for + Jetpack Compose)* +* And many more open-source projects... -[![Discord](https://img.shields.io/discord/560731361414086666?color=%235865f2&label=Discord)](https://discord.gg/VtUfRyzRXn) +--- -#### Other +### ✅ 额外建议(可选但很加分) -https://www.yuque.com/legado/wiki/community +如果你愿意,我建议你再加一个: - - # - +```md +## ⚠️ Disclaimer -# API [![](https://img.shields.io/badge/-API-F5F5F5.svg)](#API-) - -* Legado 3.0 The API is provided in 2 ways: `Web way` and `Content Provider way`. You can call it yourself as needed in [here](api.md). -* One-click import by url recall reading, url format: legado://import/{path}?src={url} -* Path Type: bookSource,rssSource,replaceRule,textTocRule,httpTTS,theme,readConfig,dictRule,addToBookshelf -* path type explanation: Book source, subscription source, replacement rules, local txt novel directory rules, online reading engine, theme, reading layout, [add to bookshelf](/app/src/main/java/io/legado/app/ui/association/AddToBookshelfDialog.kt) - - - # - - -# Other [![](https://img.shields.io/badge/-Other-F5F5F5.svg)](#Other-) - -##### Disclaimers - -https://gedoor.github.io/Disclaimer - -##### Legado 3.0 - -* [eBook sources rules](https://mgz0227.github.io/The-tutorial-of-Legado/) -* [Update Log](/app/src/main/assets/updateLog.md) -* [Help Documentation](/app/src/main/assets/web/help/md/appHelp.md) -* [web bookshelf](https://github.com/gedoor/legado_web_bookshelf) -* [web source editor](https://github.com/gedoor/legado_web_source_editor) - - - # - - -# Grateful [![](https://img.shields.io/badge/-Grateful-F5F5F5.svg)](#Grateful-) - -> * org.jsoup:jsoup -> * cn.wanghaomiao:JsoupXpath -> * com.jayway.jsonpath:json-path -> * com.github.gedoor:rhino-android -> * com.squareup.okhttp3:okhttp -> * com.github.bumptech.glide:glide -> * org.nanohttpd:nanohttpd -> * org.nanohttpd:nanohttpd-websocket -> * cn.bingoogolapple:bga-qrcode-zxing -> * com.jaredrummler:colorpicker -> * org.apache.commons:commons-text -> * io.noties.markwon:core -> * io.noties.markwon:image-glide -> * com.hankcs:hanlp -> * com.positiondev.epublib:epublib-core - - - # - - -# Interface [![](https://img.shields.io/badge/-Interface-F5F5F5.svg)](#Interface-) - - - - - - # - +This project is a **non-official fork** of Legado and is intended for learning, +personal use, and experimentation only. +``` \ No newline at end of file diff --git a/README.md b/README.md index 9d70fa2af..7b713e86a 100644 --- a/README.md +++ b/README.md @@ -1,70 +1,81 @@ ->此版本为Material Design 3风格重构版本。 +# Legado with MD3 -与[官方版本](https://github.com/gedoor/legado)的区别: -重新设计界面,使用Material Design 3设计,增加一些奇怪的新功能(和新的bug。 +

+ 简体中文 | + English +

-# Function-主要功能 -[English](English.md) -
中文 -1.自定义书源,自己设置规则,抓取网页数据,规则简单易懂,软件内有规则说明。
-2.列表书架,网格书架自由切换。
-3.书源规则支持搜索及发现,所有找书看书功能全部自定义,找书更方便。
-4.订阅内容,可以订阅想看的任何内容,看你想看
-5.支持替换净化,去除广告替换内容很方便。
-6.支持本地TXT、EPUB阅读,手动浏览,智能扫描。
-7.支持高度自定义阅读界面,切换字体、颜色、背景、行距、段距、加粗、简繁转换等。
-8.支持多种翻页模式,覆盖、仿真、滑动、滚动等。
-9.软件开源,持续优化,无广告。 -
+## 📖 介绍 +**Legado with MD3** 是基于开源项目 [阅读 (Legado)](https://github.com/gedoor/legado) 开发的 Material +Design 3 风格重构版本。 -# Community-官方交流社区 +本项目在对 UI 进行重绘的基础上,加入了多项分支独有功能,并正在逐步从传统 View 迁移至 Jetpack Compose +框架,目标是提供更加现代、流畅且一致的阅读体验。 -#### Telegram -[![Telegram-group](https://img.shields.io/badge/Telegram-%E7%BE%A4%E7%BB%84-blue)](https://t.me/yueduguanfang) [![Telegram-channel](https://img.shields.io/badge/Telegram-%E9%A2%91%E9%81%93-blue)](https://t.me/legado_channels) +> [!CAUTION] +> **注意事项:** +> 由于使用 Monet 引擎重构了主题系统,官方版本的主题在此版本中不再可用。 +> **Android 12 以下设备:** 暂时无法使用自定义主题与动态取色功能。此限制将在 Jetpack Compose +> 迁移完成后得到解决(由于开发者精力有限,迁移过程将持续较长时间)。 -#### Discord -[![Discord](https://img.shields.io/discord/560731361414086666?color=%235865f2&label=Discord)](https://discord.gg/VtUfRyzRXn) +--- -#### Other -https://www.yuque.com/legado/wiki/community +## ✨ 分支特性 -# Other-其他 -##### 免责声明 -https://gedoor.github.io/Disclaimer +相比于官方版本,本项目具有以下独有特性: -##### 阅读3.0 -* [书源规则](https://mgz0227.github.io/The-tutorial-of-Legado/) -* [更新日志](/app/src/main/assets/updateLog.md) -* [帮助文档](/app/src/main/assets/web/help/md/appHelp.md) -* [web端书架](https://github.com/gedoor/legado_web_bookshelf) -* [web端源编辑](https://github.com/gedoor/legado_web_source_editor) +* **全新主题:** 全新 Material Design 3 设计界面,支持 **预测性返回手势** 与 **共享元素动画**。 +* **阅读界面:** 更加个性化的阅读界面与菜单配置。 +* **阅读记录:** 提供详尽的阅读记录,支持 **时间轴** 与 **章节维度** 统计。 +* **体验增强:** 更健全的 **漫画阅读** 、 **有声书** 与 **发现** 等界面体验。 +* **书架布局:** 更多的书架布局选择,针对 **平板端** 进行了专门的界面优化。 +* **实用功能:** 新增书籍备注、智能伴生分组(自动归类已读/未读)等。 +--- -# Grateful-感谢 [![](https://img.shields.io/badge/-Grateful-F5F5F5.svg)](#Grateful-感谢-) -[gedoor/legado](https://github.com/gedoor/legado) +## 🛠️ 核心功能 -[Luoyacheng/legado](https://github.com/Luoyacheng/legado) +1. **自定义书源:** 强大的爬虫引擎,规则简单易懂,支持自定义抓取网页数据。 +2. **多格式支持:** 支持本地 TXT、EPUB 阅读,智能扫描本地文件。 +3. **高度自定义:** 切换字体、背景、行距、段距、加粗、简繁转换等。 +4. **订阅内容:** 不止是书,可以订阅任何你想看的内容。 +5. **净化替换:** 强力去除广告,替换正文内容。 +6. **翻页模式:** 覆盖、仿真、滑动、滚动等多种模式随心切换。 +7. **完全开源:** 无广告,持续迭代优化。 -[komikku-app/komikku](https://github.com/komikku-app/komikku) +--- -[FoedusProgramme/Gramophone](https://github.com/FoedusProgramme/Gramophone) +## 🤝 社区与支持 + +以下为原项目的社区,本项目由于开发者比较忙,暂时没有独立社区。 + +* **官方 Wiki:** [书源规则教程](https://mgz0227.github.io/The-tutorial-of-Legado/) +* **交流社区: + ** [Telegram 频道](https://t.me/legado_channels) | [Discord](https://discord.gg/VtUfRyzRXn) | [语雀 Wiki](https://www.yuque.com/legado/wiki/community) +* **相关文档: + ** [免责声明](https://gedoor.github.io/Disclaimer) | [更新日志](https://www.google.com/search?q=/app/src/main/assets/updateLog.md) + +--- + +## ❤️ 致谢 + +感谢以下优秀开源项目提供的灵感与技术支持: + +* [gedoor/legado](https://github.com/gedoor/legado) (这个项目最吊的老爹) +* [Luoyacheng/legado](https://github.com/Luoyacheng/legado) (提供了更多的扩展功能) +* [komikku-app/komikku](https://github.com/komikku-app/komikku) (提供了界面灵感与一些 Compose + 的优秀控件) +* [FoedusProgramme/Gramophone](https://github.com/FoedusProgramme/Gramophone) (提供了界面灵感与 View + 系统的封面取色方法) +* [jordond/MaterialKolor](https://github.com/jordond/MaterialKolor) (基于 Jetpack Compose + 优秀的取色实现) +* [Calvin-LL/Reorderable](https://github.com/Calvin-LL/Reorderable) (基于 Jetpack Compose + 优秀的拖动排序实现) +* 以及更多开源项目... + +## ⚠️ 免责声明 + +本项目为 **Legado(阅读)** 的非官方分支,仅用于学习、交流与个人使用。 +项目内容不代表原作者立场,与原项目作者不存在任何隶属或授权关系。 -> * org.jsoup:jsoup -> * cn.wanghaomiao:JsoupXpath -> * com.jayway.jsonpath:json-path -> * com.github.gedoor:rhino-android -> * com.squareup.okhttp3:okhttp -> * com.github.bumptech.glide:glide -> * org.nanohttpd:nanohttpd -> * org.nanohttpd:nanohttpd-websocket -> * cn.bingoogolapple:bga-qrcode-zxing -> * com.jaredrummler:colorpicker -> * org.apache.commons:commons-text -> * io.noties.markwon:core -> * io.noties.markwon:image-glide -> * com.hankcs:hanlp -> * com.positiondev.epublib:epublib-core - - # -