You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Go to file
Benoit Pierre 14f105707d make: always symlink, even for release builds (faster) 2 months ago
.ci
.circleci
.github ci/macos: pin XCode version (#12229) 2 months ago
base@0d6abcf611 make: always symlink, even for release builds (faster) 2 months ago
doc doc: explicitly mention perl dependency (#12240) 2 months ago
frontend NetworkMgr: Attempt to handle wpa_supplicant rescans better (#12236) 2 months ago
l10n@7bddf3c874
make make: always symlink, even for release builds (faster) 2 months ago
metadata
platform Kobo: Refactor various aspects of the Kaleido/MTK support (#12221) 2 months ago
plugins Kobo: Refactor various aspects of the Kaleido/MTK support (#12221) 2 months ago
resources
spec/unit
test@86eeb0b43d
tools
.busted
.codecov.yml
.editorconfig
.gitignore
.gitmodules
.luacheckrc
.luacov
.luarc.json
.shellcheckrc
COPYING
Makefile make: always symlink, even for release builds (faster) 2 months ago
README.md
datastorage.lua
defaults.lua
kodev
reader.lua Kobo: Refactor various aspects of the Kaleido/MTK support (#12221) 2 months ago
setupkoenv.lua

README.md

KOReader

KOReader is a document viewer primarily aimed at e-ink readers.

AGPL Licence Latest release Gitter Mobileread Build Status Coverage Status Weblate Status

DownloadUser guideWikiDeveloper docs

Main features

  • portable: runs on embedded devices (Cervantes, Kindle, Kobo, PocketBook, reMarkable), Android and Linux computers. Developers can run a KOReader emulator in Linux and MacOS.

  • multi-format documents: supports fixed page formats (PDF, DjVu, CBT, CBZ) and reflowable e-book formats (EPUB, FB2, Mobi, DOC, RTF, HTML, CHM, TXT). Scanned PDF/DjVu documents can also be reflowed with the built-in K2pdfopt library. ZIP files are also supported for some formats.

  • 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.

  • integrated with calibre (search metadata, receive ebooks wirelessly, browse library via OPDS), Wallabag, Wikipedia, Google Translate and other content providers.

  • 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.

  • extensible: via plugins

  • fast: on some older devices, it has been measured to have less than half the page-turn delay as the built in reading software.

  • 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, …

Please check the user guide and the wiki to discover more features and to help us document them.

Screenshots

Installation

Please follow the model specific steps for your device:

AndroidCervantesKindleKoboLinuxPocketbookreMarkable

Development

Setting up a build environmentCollaborating with GitBuilding targetsPortingDeveloper docs

Support

KOReader is developed and supported by volunteers all around the world. There are many ways you can help:

Right now we only support liberapay donations.

Contributors

Last commit Commit activity