Koreader, with all the submodules
Find a file
2025-07-21 22:25:26 +00:00
.ci CI: Update to Busted 2.0.0 2020-12-19 04:16:51 +01:00
.circleci [chore] (#6764) 2020-10-09 19:15:16 +02:00
.forgejo/workflows Inject custom workflow 2025-07-21 22:25:26 +00:00
.github Bug report changes (#7709) 2021-05-23 01:20:13 +02:00
base@028598fdf7 Fix F-Droid build (#8096) 2021-08-17 22:35:32 +02:00
doc Mention that arguments are always evaluated, to curb enthusiasm at 2021-08-09 02:32:58 +02:00
frontend Fix duplicate suspend scheduling in Device:onPowerEvent 2021-08-19 22:40:04 +02:00
l10n@de91979a86 Update translations for 2021.08 (#8109) 2021-08-20 20:58:34 +02:00
metadata/en-US add basic metadata for F-Droid 2021-06-17 21:54:03 +02:00
platform Unbreak Wi-Fi on < Mk.8 (#8077) 2021-08-14 17:28:26 +02:00
plugins ReadTimer: Small QoL fixes 2021-08-19 22:40:04 +02:00
resources Quick start guide: revamp text and look (#7985) 2021-07-20 17:22:45 +02:00
spec/unit Adds time left for chapter and document to the screensaver message options (#7897) 2021-06-30 01:45:34 +02:00
test@86eeb0b43d various test/coverage optimization 2016-08-15 00:32:40 +08:00
tools Remove PNG icons, add koreader.svg 2020-12-19 14:49:18 +01:00
.busted Travis update 2015-08-24 16:40:52 +02:00
.codecov.yml [CI] Add .codecov.yml (#4695) 2019-03-01 17:29:04 +01:00
.editorconfig experimental port to Mac OSX 2016-04-22 20:13:44 +08:00
.gitignore Add macOS target 2020-07-11 01:29:49 +02:00
.gitmodules add basic metadata for F-Droid 2021-06-17 21:54:03 +02:00
.luacheckrc Update UI layout code to use new SVG icons 2020-12-19 14:49:18 +01:00
.luacov [CI] Also run coverage on plugins (#3447) 2017-10-29 21:09:13 +01:00
.shellcheckrc [CI] Add curly braces check (#5809) 2020-02-02 20:35:21 +01:00
.travis.yml quickstart fix (#2804) 2017-04-24 08:27:29 +02:00
COPYING switch license to AGPLv3 2014-03-23 16:53:05 +08:00
datastorage.lua [CI] Mac OS app (#6955) 2020-12-11 15:16:29 +01:00
defaults.lua Raise DocumentCache hard cap to 512MB 2021-08-19 22:40:04 +02:00
kodev Bump android backend (#7813) 2021-06-07 17:13:34 +02:00
Makefile Bump android backend (#7813) 2021-06-07 17:13:34 +02:00
reader.lua FileManager/ReaderUI: Clarify the current instance accessor (#7658) 2021-05-11 00:49:35 +02:00
README.md Readme: add link to user guide (#8110) 2021-08-21 07:23:34 +02:00
setupkoenv.lua Truly silence the attempt at loading SDL2 2021-05-19 20:55:00 +02:00

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), Evernote (export hightlights), 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, share ebooks with other KOReader devices wirelessly, online 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