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 c345de5d71
ci: drop travis configuration (unused) (#11676)
3 days ago
.ci [CI] Don't hide docs generation log (#9204) 2 years ago
.circleci [CI] Also use Ubuntu 20.04 Docker image for docs (#9209) 2 years ago
.github [CI] Bump actions/upload-artifact from 3 to 4 (#11242) 4 months ago
base@781db25317 bump base, luajit-launcher, avoid assert failure in sub-processes (#11658) 6 days ago
doc doc: remove ragel from the build requirements (#11661) 6 days ago
frontend bump base, luajit-launcher, avoid assert failure in sub-processes (#11658) 6 days ago
l10n@7e75ac4b28 Update translations for v2024.03 (#11508) 1 month ago
metadata update metadata & translations 2 years ago
platform bump base, luajit-launcher, avoid assert failure in sub-processes (#11658) 6 days ago
plugins covermenu: fix file dialog (#11576) 4 weeks ago
resources Bookmark flipping mode fix (#10196) 1 year ago
spec/unit ReaderZooming: make auto-crop default be page content (#11438) 1 month ago
test@86eeb0b43d various test/coverage optimization 8 years ago
tools Chore: Review FrameContainer constructors for shared dimen objects 3 months 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 add basic metadata for F-Droid 3 years 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) 10 months ago
.shellcheckrc [CI] Add curly braces check (#5809) 4 years ago
COPYING switch license to AGPLv3 10 years ago
Makefile make: improve `appimageupdate` rule, take 2 (#11671) 5 days ago
README.md Remove bountysource from README (#11385) 1 month ago
datastorage.lua DocSettings: check legacy history location only once (#11439) 2 months ago
defaults.lua ImageViewer: menu to invert rotations and set auto rotation (#11206) 4 months ago
kodev Never export LD_LIBRARY_PATH 9 months ago
reader.lua Reader: use existing module instances on start (#11485) 2 months ago
setupkoenv.lua Env: Actually use the full ffi.load signature in our overload 9 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