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
hius07 92bcbe06f6
readertypeset: fix margins info (#12609)
3 days ago
.ci ci/circle: fix tests parallelism (#12551) 2 weeks ago
.circleci
.github ci/macos: fix homebrew packages install (#12382) 2 months ago
base@446b7f3bac bump base, macOS edition (#12605) 4 days ago
doc doc: update Android build instructions (#12368) 2 months ago
frontend readertypeset: fix margins info (#12609) 3 days ago
l10n@7bddf3c874
make android: fix apkanalyzer location 1 week ago
metadata update metadata translations for fdroid/flathub (#12581) 4 days ago
platform Add wifi support to Cervantes Touch Light devices (#12148) 4 days ago
plugins [plugin] Exporter: fix typo (#12592) 7 days ago
resources Quickstart guide Kindle illustrations (#12577) 1 week ago
spec/unit input: drop use of `ffi/input` 2 weeks ago
test@86eeb0b43d
tools android: add custom `adb logcat` formatter (#12385) 2 months ago
.busted
.codecov.yml
.editorconfig experimental port to Mac OSX 9 years ago
.gitignore
.gitmodules
.luacheckrc
.luacov
.luarc.json
.shellcheckrc
COPYING
Makefile
README.md
datastorage.lua
defaults.lua Defaults: Deprecate DKOPTREADER_CONFIG_DOC_LANGS_TEXT 4 weeks ago
kodev Add kobov4 & kobov5 targets 1 week ago
reader.lua
setupkoenv.lua use new `ffi.loadlib` helper (#12545) 2 weeks ago

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