2018-04-15 18:35:02 +00:00
[](https://koreader.rocks)
2019-08-20 15:01:28 +00:00
#### KOReader is a document viewer primarily aimed at e-ink readers.
2018-06-02 16:10:55 +00:00
2019-08-20 15:01:28 +00:00
[![AGPL Licence][badge-license]](COPYING)
[![Latest release][badge-release]][link-gh-releases]
[![Gitter][badge-gitter]][link-gitter]
[![Mobileread][badge-mobileread]][link-forum]
[![Build Status][badge-circleci]][link-circleci]
[![Coverage Status][badge-coverage]][link-coverage]
2019-12-31 14:39:15 +00:00
[![Weblate Status][badge-weblate]][link-weblate]
2016-04-14 17:18:19 +00:00
2019-08-20 15:01:28 +00:00
[Download ](https://github.com/koreader/koreader/releases ) •
2021-08-21 05:23:34 +00:00
[User guide ](http://koreader.rocks/koreader-user-guide.pdf ) •
2019-08-20 15:01:28 +00:00
[Wiki ](https://github.com/koreader/koreader/wiki ) •
[Developer docs ](http://koreader.rocks/doc/ )
2015-04-27 00:43:32 +00:00
2019-08-20 15:01:28 +00:00
## Main features
2016-05-24 05:38:08 +00:00
2020-02-12 07:13:11 +00:00
* **portable**: runs on embedded devices (Cervantes, Kindle, Kobo, PocketBook, reMarkable), Android and Linux computers. Developers can run a KOReader emulator in Linux and MacOS.
2014-03-25 14:26:36 +00:00
2019-08-20 15:01:28 +00:00
* **multi-format documents**: supports fixed page formats (PDF, DjVu, CBT, CBZ) and reflowable e-book formats (EPUB, FB2, Mobi, DOC, CHM, TXT). Scanned PDF/DjVu documents can also be reflowed with the built-in K2pdfopt library.
2013-03-24 19:13:03 +00:00
2019-08-20 15:01:28 +00:00
* **full-featured reading**: multi-lingual user interface with a highly customizable reader view and many typesetting options. You can set arbitrary page margins, override line spacing and choose external fonts and styles. It has multi-lingual hyphenation dictionaries bundled into the application.
2014-01-01 21:07:28 +00:00
2021-09-04 09:54:30 +00:00
* **integrated** with *calibre* (search metadata, receive ebooks wirelessly, browse library via OPDS), *Wallabag* , *Wikipedia* , *Google Translate* and other content providers.
2014-01-01 21:07:28 +00:00
2019-08-20 15:01:28 +00:00
* **optimized for e-ink devices**: custom UI without animation, with paginated menus, adjustable text contrast, and easy zoom to fit content or page in paged media.
2017-02-28 19:03:24 +00:00
2019-08-20 15:01:28 +00:00
* **extensible**: via plugins
2017-02-28 19:03:24 +00:00
2021-08-17 07:27:37 +00:00
* **fast**: on some older devices, it has been measured to have less than half the page-turn delay as the built in reading software.
2021-09-04 09:54:30 +00:00
* **and much more**: look up words with StarDict dictionaries / Wikipedia, add your own online OPDS catalogs and RSS feeds, over-the-air software updates, an FTP client, an SSH server, …
2017-02-28 19:03:24 +00:00
2021-08-21 05:23:34 +00:00
Please check the [user guide ](http://koreader.rocks/koreader-user-guide.pdf ) and the [wiki][link-wiki] to discover more features and to help us document them.
2017-02-28 19:03:24 +00:00
2019-08-20 15:01:28 +00:00
## Screenshots
2017-02-28 19:03:24 +00:00
2019-08-20 15:01:28 +00:00
< a href = "https://github.com/koreader/koreader-artwork/raw/master/koreader-menu.png" > < img src = "https://github.com/koreader/koreader-artwork/raw/master/koreader-menu-thumbnail.png" alt = "" width = "200px" > < / a >
< a href = "https://github.com/koreader/koreader-artwork/raw/master/koreader-footnotes.png" > < img src = "https://github.com/koreader/koreader-artwork/raw/master/koreader-footnotes-thumbnail.png" alt = "" width = "200px" > < / a >
< a href = "https://github.com/koreader/koreader-artwork/raw/master/koreader-dictionary.png" > < img src = "https://github.com/koreader/koreader-artwork/raw/master/koreader-dictionary-thumbnail.png" alt = "" width = "200px" > < / a >
2017-02-28 19:03:24 +00:00
2019-08-20 15:01:28 +00:00
## Installation
2017-02-28 19:03:24 +00:00
2019-08-20 15:01:28 +00:00
Please follow the model specific steps for your device:
2017-02-28 19:03:24 +00:00
2019-08-20 15:01:28 +00:00
[Android ](https://github.com/koreader/koreader/wiki/Installation-on-Android-devices ) •
[Cervantes ](https://github.com/koreader/koreader/wiki/Installation-on-BQ-devices ) •
[Kindle ](https://github.com/koreader/koreader/wiki/Installation-on-Kindle-devices ) •
[Kobo ](https://github.com/koreader/koreader/wiki/Installation-on-Kobo-devices ) •
[Linux ](https://github.com/koreader/koreader/wiki/Installation-on-desktop-linux ) •
2020-02-12 07:13:11 +00:00
[Pocketbook ](https://github.com/koreader/koreader/wiki/Installation-on-PocketBook-devices ) •
[reMarkable ](https://github.com/koreader/koreader/wiki/Installation-on-Remarkable )
2013-03-24 16:18:53 +00:00
2014-06-05 12:54:36 +00:00
2019-08-20 15:01:28 +00:00
## Development
2014-11-29 20:46:33 +00:00
2020-08-15 17:37:18 +00:00
[Setting up a build environment ](doc/Building.md ) •
2019-08-20 15:01:28 +00:00
[Collaborating with Git ](doc/Collaborating_with_Git.md ) •
[Building targets ](doc/Building_targets.md ) •
[Porting ](doc/Porting.md ) •
[Developer docs ](http://koreader.rocks/doc/ )
2014-11-29 20:46:33 +00:00
2019-08-20 15:01:28 +00:00
## Support
2014-11-29 20:46:33 +00:00
2019-08-20 15:01:28 +00:00
KOReader is developed and supported by volunteers all around the world. There are many ways you can help:
2013-03-24 19:13:03 +00:00
2019-08-20 15:01:28 +00:00
- [fix bugs][link-issues-bugs] and [implement new features][link-issues-features]
2019-12-31 14:39:15 +00:00
- [translate the program into your language][link-weblate] or improve an existing translation
2019-10-12 11:37:21 +00:00
- document lesser-known features on the [wiki][link-wiki]
2019-08-20 15:01:28 +00:00
- help others with your knowledge on the [forum][link-forum]
2013-04-20 22:28:42 +00:00
2020-02-04 11:49:21 +00:00
Right now we only support [liberapay ](https://liberapay.com/KOReader ) donations, but you can also create a [bounty][link-bountysource] to motivate others to work on a specific bug or feature request.
2013-03-26 23:21:30 +00:00
2019-08-20 15:01:28 +00:00
## Contributors
2018-08-18 06:42:14 +00:00
2019-08-20 15:01:28 +00:00
[![Last commit][badge-last-commit]][link-gh-commits]
[![Commit activity][badge-commit-activity]][link-gh-insights]
2018-08-18 06:42:14 +00:00
2019-08-20 15:01:28 +00:00
[badge-bountysource]:https://img.shields.io/bountysource/team/koreader/activity?color=red
[badge-circleci]:https://circleci.com/gh/koreader/koreader.svg?style=shield
[badge-coverage]:https://codecov.io/gh/koreader/koreader/branch/master/graph/badge.svg
[badge-commit-activity]:https://img.shields.io/github/commit-activity/m/koreader/koreader
[badge-gitter]:https://img.shields.io/gitter/room/koreader/koreader?color=red
[badge-last-commit]:https://img.shields.io/github/last-commit/koreader/koreader?color=orange
[badge-license]:https://img.shields.io/github/license/koreader/koreader
[badge-release]:https://img.shields.io/github/release/koreader/koreader.svg
[badge-mobileread]:https://img.shields.io/badge/forum-on_mobileread-lightgrey
2019-12-31 14:39:15 +00:00
[badge-weblate]:https://hosted.weblate.org/widgets/koreader/-/koreader/svg-badge.svg
2019-08-20 15:01:28 +00:00
[link-bountysource]:https://www.bountysource.com/teams/koreader
[link-circleci]:https://circleci.com/gh/koreader/koreader
[link-coverage]:https://codecov.io/gh/koreader/koreader
[link-forum]:http://www.mobileread.com/forums/forumdisplay.php?f=276
[link-gh-commits]:https://github.com/koreader/koreader/commits/master
[link-gh-insights]:https://github.com/koreader/koreader/pulse
[link-gh-releases]:https://github.com/koreader/koreader/releases
[link-gitter]:https://gitter.im/koreader/koreader
[link-issues-bugs]:https://github.com/koreader/koreader/issues?q=is%3Aopen+is%3Aissue+label%3Abug
[link-issues-features]:https://github.com/koreader/koreader/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement
2019-12-31 14:39:15 +00:00
[link-weblate]:https://hosted.weblate.org/engage/koreader/?utm_source=widget
2019-08-20 15:01:28 +00:00
[link-wiki]:https://github.com/koreader/koreader/wiki
