You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
NiLuJe 2d5bde3ade
Input: Unbreak event handling on strict protocol B devices (#9445)
10 hours ago
.ci [CI] Don't hide docs generation log (#9204) 2 months ago
.circleci [CI] Also use Ubuntu 20.04 Docker image for docs (#9209) 2 months ago
.github [CI] Downgrade macOS Github Action to macOS 10.15 (#9279) 1 month ago
base@7fb47e4605 CRe, MuPDF, PicDocument: add support for WebP images (#9402) 2 weeks ago
doc [doc] Update busted version mentioned in docs (#9078) 3 months ago
frontend Input: Unbreak event handling on strict protocol B devices (#9445) 10 hours ago
l10n@f18f0e5dd4 Update translations for 2022.07 (#9394) 3 weeks ago
metadata/en-US F-Droid description: tame expectations (#8178) 12 months ago
platform kindle: allow stopping the framework on 5.X 3 days ago
plugins [plugin] Fix crash in AutoWarmth (#9411) 1 week ago
resources Keyboard: add Bengali Probhat layout (#8887) 5 months ago
spec/unit Input: Actually fix the timer double-free 2 days ago
test@86eeb0b43d various test/coverage optimization 6 years ago
tools add tool to update F-Droid metadata based on weblate translations (#9090) 2 weeks ago
.busted Travis update 7 years ago
.codecov.yml [CI] Add .codecov.yml (#4695) 4 years ago
.editorconfig experimental port to Mac OSX 6 years ago
.gitignore Add macOS target 2 years ago
.gitmodules add basic metadata for F-Droid 1 year ago
.luacheckrc luacheckrc: allow busted's "match" global for spec/ (#8369) 10 months ago
.luacov [CI] Also run coverage on plugins (#3447) 5 years ago
.shellcheckrc [CI] Add curly braces check (#5809) 3 years ago
.travis.yml quickstart fix (#2804) 5 years ago
COPYING switch license to AGPLv3 9 years ago
Makefile userpatch: allow monkey-patching KOReader (#9104) 2 months ago
README.md Readme: Tame down expectations (#8177) 12 months ago
datastorage.lua Fix koreader not using XDG_CONFIG_HOME on linux (#8507) 9 months ago
defaults.lua Raise DocumentCache hard cap to 512MB 1 year ago
kodev Bump android backend (#7813) 1 year ago
reader.lua userpatch: allow monkey-patching KOReader (#9104) 2 months ago
setupkoenv.lua setupkoenv: ffi.load: search rocks 5 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, 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