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
Frans de Jonge 10305789dc
[i18n] Add context to various none/auto/small/medium/large (#8489)
Needed for Greek and possibly other languages.

Closes #8478.
3 years ago
.ci
.circleci [CI] Fix certificate issue with quick koreader/koappimage:0.1.8 (#8305) 3 years ago
.github
base@c56be0ce63 bump crengine and button-listen.c for reMarkable 3 years ago
doc Fix docs, evernote → exporter (#8158) 3 years ago
frontend [i18n] Add context to various none/auto/small/medium/large (#8489) 3 years ago
l10n@610314844d Update translations for 2021.11 (#8452) 3 years ago
metadata/en-US F-Droid description: tame expectations (#8178) 3 years ago
platform android: bump test activity (#8483) 3 years ago
plugins [autosuspend, plugin] Switch to datetimewidget and provide default values (#8480) 3 years ago
resources
spec/unit [autosuspend, plugin] Switch to datetimewidget and provide default values (#8480) 3 years ago
test@86eeb0b43d
tools keyboard: japanese: always put digits as the south gesture for latin (#8443) 3 years ago
.busted
.codecov.yml
.editorconfig
.gitignore
.gitmodules
.luacheckrc luacheckrc: allow busted's "match" global for spec/ (#8369) 3 years ago
.luacov
.shellcheckrc
.travis.yml
COPYING
Makefile
README.md Readme: Tame down expectations (#8177) 3 years ago
datastorage.lua
defaults.lua Raise DocumentCache hard cap to 512MB 3 years ago
kodev
reader.lua
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, CHM, TXT). Scanned PDF/DjVu documents can also be reflowed with the built-in K2pdfopt library.

  • 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, but you can also create a bounty to motivate others to work on a specific bug or feature request.

Contributors

Last commit Commit activity