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
Martín Fernández ba8891082c
fix after #11833 (#11849)
23 hours ago
.ci ci/circle: improve caching 5 days ago
.circleci ci: force color output 5 days ago
.github ci/macos: install ninja 5 days ago
base@f9c9316709 Kindle: Don't forget about fiveways on legacy devices & fix a couple input-scan misdetections (#11827) 4 days ago
doc doc: fix android NDK / SDK instructions (#11818) 5 days ago
frontend PocketBook: Open links in the on-device web browser (#11787) 24 hours ago
l10n@76f8b999c8 Update translations for v2024.04 (#11726) 3 weeks ago
make fix after #11833 (#11849) 23 hours ago
metadata bump metadata translations (#11842) 2 days ago
platform SDL: add flatpak flavor (#11833) 1 day ago
plugins Replace tweak_buttons_func with an event instead (#11777) 3 days ago
resources Bookmark flipping mode fix (#10196) 1 year ago
spec/unit tests/readerhighlight: speedup 1 week ago
test@86eeb0b43d various test/coverage optimization 8 years ago
tools tools/mk7z: support debian unstable / ubuntu 22.04 1 week ago
.busted Travis update 9 years ago
.codecov.yml [CI] Add .codecov.yml (#4695) 5 years ago
.editorconfig experimental port to Mac OSX 8 years ago
.gitignore Add macOS target 4 years ago
.gitmodules l10n: mark git submodule for shallow updates 1 month ago
.luacheckrc Cleanup various varargs shenanigans (#9624) 2 years ago
.luacov [CI] Also run coverage on plugins (#3447) 7 years ago
.luarc.json Add a config file for the Lua LSP (#10611) 11 months ago
.shellcheckrc [CI] Add curly braces check (#5809) 4 years ago
COPYING switch license to AGPLv3 10 years ago
Makefile SDL: add flatpak flavor (#11833) 1 day ago
README.md Remove bountysource from README (#11385) 3 months ago
datastorage.lua SDL: add flatpak flavor (#11833) 1 day ago
defaults.lua ImageViewer: menu to invert rotations and set auto rotation (#11206) 5 months ago
kodev Add generic Linux package (#9351) 6 days ago
reader.lua Reader: use existing module instances on start (#11485) 3 months ago
setupkoenv.lua Env: Actually use the full ffi.load signature in our overload 10 months 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