mirror/koodo-reader
1
0
Fork 0
mirror of https://github.com/koodo-reader/koodo-reader.git synced 2026-06-18 04:40:11 -04:00
Code Issues Packages Projects Releases Wiki Activity
Files
15ddeade4795f15540335aa2d80bdf60960f9fbb
koodo-reader/README.md

211 lines
7.8 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<div align="left">
[简体中文](https://github.com/koodo-reader/koodo-reader/blob/master/README_cn.md) | [हिंदी](https://github.com/koodo-reader/koodo-reader/blob/master/README_hi.md)
|[Português](https://github.com/koodo-reader/koodo-reader/blob/master/README_pt.md) | [Indonesian](https://github.com/koodo-reader/koodo-reader/blob/master/README_id.md) | English
</div>
<div align="center" >
<img src="https://dl.koodoreader.com/screenshots/logo.png" width="96px" height="96px"/>
</div>
<h1 align="center">
Koodo Reader
</h1>
<h3 align="center">
A cross-platform ebook reader
</h3>
<div align="center">
[Download](https://koodoreader.com/en) | [Preview](https://web.koodoreader.com) | [Roadmap](https://koodoreader.com/en/roadmap) | [Document](https://koodoreader.com/en/document) | [Plugins](https://koodoreader.com/en/plugin)
</div>
## Preview
<div align="center">
<br/>
<br/>
<img src="https://dl.koodoreader.com/screenshots/7.png" width="800px">
<br/>
<br/>
<img src="https://dl.koodoreader.com/screenshots/8.png" width="800px">
<br/>
<br/>
</div>
## Features
- Format support:
- EPUB (**.epub**)
- PDF (**.pdf**)
- DRM-free Mobipocket (**.mobi**) and Kindle (**.azw3**, **.azw**)
- Plain-text (**.txt**)
- FictionBook (**.fb2**)
- Comic book archive (**.cbr**, **.cbz**, **.cbt**, **.cb7**)
- Rich text (**.md**, **.docx**)
- HyperText (**.html**, **.xml**, **.xhtml**, **.mhtml**, **.htm**)
- Platform support: **Windows**, **macOS**, **Linux**, **Android**, **iOS** and **Web**
- Sync and backup your data with **OneDrive**, **Google Drive**, **Dropbox**, **iCloud**, **MEGA**, **pCloud**, **Yandex Disk**, **Box**, **FTP**, **SFTP**, **WebDAV**, **SMB**, or **Object Storage**
- Easily import books from **OneDrive**, **Google Drive**, **MEGA**, **Yandex Disk**, **Box**, **FTP**, **SFTP**, **WebDAV**, **SMB**, or **Object Storage**
- AI dictionary, summarization, encyclopedia and translation
- Single-column, two-column or continuous scrolling layouts
- Text-to-speech, translation, dictionary, touch screen support, and batch import
- Add bookmarks, notes, and highlights to your books
- Adjust font size, font family, line-spacing, paragraph spacing, background color, text color, margins, and brightness
- Night mode and theme color
- Text highlighting, underline, boldness, italics, and shadow
## Installation
### Desktop version: [Download](https://koodoreader.com/en/download)
### Web version：[Visit](https://web.koodoreader.com)
### Android version：[Download](https://koodoreader.com/en/download)
### iOS version：[Download](https://koodoreader.com/en/download)
### Install with Scoop:
```shell
scoop bucket add extras
scoop install extras/koodo-reader
```
### Install with Homebrew:
```shell
brew install --cask koodo-reader
```
### Install with Docker:
[Installation Guide](https://koodoreader.com/en/deploy-docker)
## Screenshot
<div align="center">
<b>Book list</b>
<br/>
<br/>
<kbd><img src="https://dl.koodoreader.com/screenshots/1.png" width="800px"></kbd>
<br/>
<br/>
<b>Book display</b>
<br/>
<br/>
<kbd><img src="https://dl.koodoreader.com/screenshots/5.png" width="800px"></kbd>
<br/>
<br/>
<b>List mode</b>
<br/>
<br/>
<kbd><img src="https://dl.koodoreader.com/screenshots/2.png" width="800px"></kbd>
<br/>
<br/>
<b>Cover mode</b>
<br/>
<br/>
<kbd><img src="https://dl.koodoreader.com/screenshots/3.png" width="800px"></kbd>
<br/>
<br/>
<b>Reader menu</b>
<br/>
<br/>
<kbd><img src="https://dl.koodoreader.com/screenshots/6.png" width="800px"></kbd>
<br/>
<br/>
<b>Dark mode</b>
<br/>
<br/>
<kbd><img src="https://dl.koodoreader.com/screenshots/4.png" width="800px"></kbd>
<br/>
</div>
## Develop
Make sure that you have installed yarn and git
1. Download the repo
```
git clone https://github.com/koodo-reader/koodo-reader.git
```
2. Enter desktop mode
```
yarn
yarn dev
```
3. Enter web mode
```
yarn
yarn start
```
## Translation
### Edit current language
1. Select your target language from the following list.
2. Click the view button to examine the source file. The untranslated terms are listed at the bottom of each file.
3. Translate the terms to your target language based on the given English reference
4. Submit the translation file or just translation snippets based on the amount of your translation to [this link](https://github.com/koodo-reader/koodo-reader/issues/new?assignees=&labels=submit+translation&projects=&template=submit_translation.yml). Pull request is also welcomed.
| Language(A-Z) | Code | View |
| --------------- | ----- | --------------------------------------- |
| Amharic | am | [View](./src/assets/locales/am.json) |
| Arabic | ar | [View](./src/assets/locales/ar.json) |
| Armenian | hy | [View](./src/assets/locales/hy.json) |
| Bengali | bn | [View](./src/assets/locales/bn.json) |
| Bulgarian | bg | [View](./src/assets/locales/bg.json) |
| Chinese (CN) | zh-CN | [View](./src/assets/locales/zh-CN.json) |
| Chinese (MO) | zh-MO | [View](./src/assets/locales/zh-MO.json) |
| Chinese (TW) | zh-TW | [View](./src/assets/locales/zh-TW.json) |
| Czech | cs | [View](./src/assets/locales/cs.json) |
| Danish | da | [View](./src/assets/locales/da.json) |
| Dutch | nl | [View](./src/assets/locales/nl.json) |
| English | en | [View](./src/assets/locales/en.json) |
| Finnish | fi | [View](./src/assets/locales/fi.json) |
| French | fr | [View](./src/assets/locales/fr.json) |
| German | de | [View](./src/assets/locales/de.json) |
| Greek | el | [View](./src/assets/locales/el.json) |
| Hindi | hi | [View](./src/assets/locales/hi.json) |
| Hungarian | hu | [View](./src/assets/locales/hu.json) |
| Indonesian | id | [View](./src/assets/locales/id.json) |
| Interlingue | ie | [View](./src/assets/locales/ie.json) |
| Irish | ga | [View](./src/assets/locales/ga.json) |
| Italian | it | [View](./src/assets/locales/it.json) |
| Japanese | ja | [View](./src/assets/locales/ja.json) |
| Korean | ko | [View](./src/assets/locales/ko.json) |
| Persian | fa | [View](./src/assets/locales/fa.json) |
| Polish | pl | [View](./src/assets/locales/pl.json) |
| Portuguese | pt | [View](./src/assets/locales/pt.json) |
| Portuguese (BR) | pt-BR | [View](./src/assets/locales/pt-BR.json) |
| Romanian | ro | [View](./src/assets/locales/ro.json) |
| Russian | ru | [View](./src/assets/locales/ru.json) |
| Slovenian | sl | [View](./src/assets/locales/sl.json) |
| Spanish | es | [View](./src/assets/locales/es.json) |
| Swedish | sv | [View](./src/assets/locales/sv.json) |
| Tamil | ta | [View](./src/assets/locales/ta.json) |
| Thai | th | [View](./src/assets/locales/th.json) |
| Tagalog | tl | [View](./src/assets/locales/tl.json) |
| Tibetan | bo | [View](./src/assets/locales/bo.json) |
| Turkish | tr | [View](./src/assets/locales/tr.json) |
| Ukrainian | uk | [View](./src/assets/locales/uk.json) |
| Vietnamese | vi | [View](./src/assets/locales/vi.json) |
### Add new language
1. If you can't find your target language from the above list, download the English source file from [this link](./src/assets/locales/en.json).
2. When you're finished translating, submit the source file to [this link](https://github.com/koodo-reader/koodo-reader/issues/new?assignees=&labels=submit+translation&projects=&template=submit_translation.yml). Pull requests are also welcome.
Reference in New Issue View Git Blame Copy Permalink