154 lines
11 KiB
Markdown
154 lines
11 KiB
Markdown
<!------------ Header ------------>
|
||
|
||
<div align="center">
|
||
<img src="fastlane/metadata/android/en-US/images/icon_2.png" width="120" />
|
||
<h1>Book's Story</h1>
|
||
<h3>Material You eBook Reader for Android</h3>
|
||
<p>Dive into the world of adventure as you discover your favorite book's story!</p>
|
||
</div>
|
||
|
||
---
|
||
|
||
<!------------ Badges ------------>
|
||
|
||
<div align="center">
|
||
|
||
<a href="">[](https://github.com/Acclorite/book-story/releases)</a>
|
||
<a href="">[](https://gitlab.com/Acclorite/book-story/-/releases)</a>
|
||
<a href="">[](https://f-droid.org/packages/ua.acclorite.book_story/)</a>
|
||
<a href="">[](https://apt.izzysoft.de/fdroid/index/apk/ua.acclorite.book_story)</a>
|
||
<a href="">[](https://hosted.weblate.org/engage/book-story/)</a>
|
||
<a href="">[](https://matrix.to/#/#book-story:matrix.org)</a>
|
||
<a href="">[](LICENSE)</a>
|
||
|
||
<!------------ Overview ------------>
|
||
|
||
<h1>Overview</h1>
|
||
|
||
</div>
|
||
|
||
<img src="fastlane/metadata/android/en-US/images/featureGraphic.png">
|
||
|
||
Enjoy a sleek, customizable **reading app** with modern design, built with Jetpack Compose. It’s open-source, offering you a personalized, ad-free journey through your favorite books!
|
||
|
||
---
|
||
|
||
<!------------ Screenshots ------------>
|
||
|
||
## 🖌️ Screenshots
|
||
|
||
<div>
|
||
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/1.png" width="30%" />
|
||
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/2.png" width="30%" />
|
||
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/3.png" width="30%" />
|
||
<hr width=91%>
|
||
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/4.png" width="30%" />
|
||
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/5.png" width="30%" />
|
||
<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/6.png" width="30%" />
|
||
</div>
|
||
|
||
---
|
||
|
||
<!------------ Features ------------>
|
||
|
||
## ✨ Features
|
||
- 7 supported file formats(.pdf, .txt, .epub, .fb2, .html, .htm, .md)
|
||
- Material You design with unique themes and color presets
|
||
- Organized Library with categories and chapters in Reader
|
||
- Highly customizable
|
||
|
||
---
|
||
|
||
<!------------ Download guide ------------>
|
||
|
||
## ✈️ Download
|
||
- _Please note, that the app supports Android versions only from Android 8.0_
|
||
|
||
<div align="left">
|
||
|
||
[<img src="https://raw.githubusercontent.com/Kunzisoft/Github-badge/main/get-it-on-github.png" alt='Get it on GitHub' height="80">](https://github.com/Acclorite/book-story/releases/latest)
|
||
[<img src="https://censorship.no/img/gitlab-badge.png" alt='Get it on GitLab' height="80">](https://gitlab.com/Acclorite/book-story/-/releases)
|
||
[<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png" alt="Get it on F-Droid" height="80">](https://f-droid.org/en/packages/ua.acclorite.book_story/)
|
||
[<img src="https://gitlab.com/IzzyOnDroid/repo/-/raw/master/assets/IzzyOnDroid.png" alt="Get it on IzzyOnDroid" height="80">](https://apt.izzysoft.de/fdroid/index/apk/ua.acclorite.book_story)
|
||
</div>
|
||
|
||
_Don't see your favorite app store? Create an [Issue](https://github.com/Acclorite/book-story/issues)!_
|
||
|
||
---
|
||
|
||
### 📲 How to download and install
|
||
|
||
- _**Installing from GitHub**_: Click the "Get it on GitHub" badge above, scroll down, and download
|
||
**book-story.apk**, or grab the latest APK
|
||
directly [here](https://github.com/Acclorite/book-story/releases/latest/download/book-story.apk).
|
||
Once downloaded, locate the APK file and install it.
|
||
- _**Installing from GitLab**_: Click the "Get it on GitLab" badge above, scroll down, and download
|
||
**book-story.apk**. Once downloaded, locate the APK file and install it.
|
||
- _**Installing from F-Droid**_: Click the "Get it on F-Droid" badge above, scroll down, and click "Download APK" under your desired release version to download the APK file. Once downloaded, locate the file and install it.
|
||
- _**Installing from IzzyOnDroid**_: Click the "Get it on IzzyOnDroid" badge above, scroll down, and click "Download" to get the latest APK from IzzyOnDroid. Once downloaded, locate the file and install it.
|
||
- If you're unsure how to install an APK file, follow [this](https://www.lifewire.com/install-apk-on-android-4177185) guide.
|
||
|
||
---
|
||
|
||
### 🧭 Afterwards
|
||
Open the app and follow the basic instructions. If you're unsure how to use the app, refer to the Help screen (accessible via: Library, History, Browse → Three Dots → Help). If you still have questions, feel free to ask in the [Discussions](https://github.com/Acclorite/book-story/discussions/categories/q-a) or create an [Issue](https://github.com/Acclorite/book-story/issues) for areas you think need better documentation.
|
||
|
||
---
|
||
|
||
<!------------ Translation ------------>
|
||
|
||
## 🌐 Translation
|
||
|
||
[<img src="https://hosted.weblate.org/widget/book-story/book-story-translation/horizontal-auto.svg" alt="Translation progress">](https://hosted.weblate.org/engage/book-story/)
|
||
<br/>
|
||
|
||
_Help translate the app on [Hosted Weblate](https://hosted.weblate.org/engage/book-story/)._
|
||
|
||
---
|
||
|
||
<!------------ Contribution ------------>
|
||
|
||
## 🤝 How to contribute
|
||
- **The most important thing is that I do not want anyone else's code.** This project is maintained solely by me, and I intend to keep it that way. Pull requests will likely be closed, as they don’t align with the project's vision.
|
||
- **Submit your suggestions on Issues with the [Suggestion Needed](https://github.com/Acclorite/book-story/labels/%F0%9F%93%9D%20Suggestion%20needed) label.** When an issue has this label, it means I'm looking for ideas on how to improve what I’ve already proposed. Feel free to share your thoughts!
|
||
- **Join the Matrix server** to share your ideas, report bugs, or just chat with me on [this server](https://matrix.to/#/#book-story:matrix.org)!
|
||
- **Share your ideas and suggestions.** If you’re missing a feature or have an interesting idea, feel free to create a new [Issue](https://github.com/Acclorite/book-story/issues).
|
||
- **Report bugs.** Encountered a crash or something went wrong? Create a new [Issue](https://github.com/Acclorite/book-story/issues) with as much detail as possible to help resolve it.
|
||
- **Translate the app.** You can help make the app accessible in multiple languages. To contribute, visit [Hosted Weblate](https://hosted.weblate.org/engage/book-story/).
|
||
- **Enjoy the app.** The best contribution is simply using and enjoying the app I spent so much time on!
|
||
|
||
---
|
||
|
||
<!------------ Credits and License ------------>
|
||
|
||
## 🤗 Credits
|
||
|
||
- [Tachiyomi (Mihon)](https://github.com/mihonapp/mihon) (GitHub)
|
||
- [Kitsune](https://github.com/Drumber/Kitsune) (GitHub)
|
||
- [Voyager](https://voyager.adriel.cafe/) (Voyager Website)
|
||
- [Material Design Icons](https://fonts.google.com/icons) (Google Fonts)
|
||
- [Material Design Fonts](https://fonts.google.com) (Google Fonts)
|
||
- [Weblate Translators](https://hosted.weblate.org/projects/book-story) (Hosted Weblate)
|
||
- [Censorship / GitLab Badge](https://censorship.no/en/index.html) (Censorship Website)
|
||
- [GitHub Badge](https://github.com/Kunzisoft/Github-badge) (GitHub)
|
||
- Also listed in About > Credits.
|
||
|
||
---
|
||
|
||
## 🧾 License
|
||
<div align="center">
|
||
<pre>
|
||
|
||
This program is free software: you can redistribute it and/or modify
|
||
it under the terms of the GNU General Public License as published by
|
||
the Free Software Foundation, version 3 of the License.
|
||
|
||
This program is distributed in the hope that it will be useful,
|
||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
GNU General Public License for more details.
|
||
|
||
You should have received a copy of the GNU General Public License
|
||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||
</pre>
|
||
</div>
|