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
hius07 477d6865f1
toggleswitch: fix long-press (#12215)
3 days ago
.ci ci: fix shellchecks helper 1 month ago
.circleci ci/circle: bump docker image (#12166) 2 weeks ago
.github ci/macos: fix fallback cache key (#12188) 1 week ago
base@b820ba51df bump crengine: various fixes and optimizations (#12200) 6 days ago
doc doc: update macOS building instructions 1 week ago
frontend toggleswitch: fix long-press (#12215) 3 days ago
l10n@7bddf3c874 bump translations (#12193) 7 days ago
make Add kindlehf target (#11986) 2 months ago
metadata update tool to generate metadata translations (#11869) 2 months ago
platform Bump platform/android/luajit-launcher 7 days ago
plugins Annotations: pageno honors reference pages and hidden flows (#12214) 3 days ago
resources Collections: add collection mark to books (#11868) 2 months ago
spec/unit djvu: honor render mode when reflowing 1 week ago
test@86eeb0b43d various test/coverage optimization 8 years ago
tools [minor] Fix lowercase typo in "Google Translate" (#12157) 2 weeks 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 3 months 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) 1 year ago
.shellcheckrc [CI] Add curly braces check (#5809) 5 years ago
COPYING switch license to AGPLv3 10 years ago
Makefile tweaks for new build system 2 months ago
README.md Remove bountysource from README (#11385) 5 months ago
datastorage.lua SDL: add flatpak flavor (#11833) 2 months ago
defaults.lua ImageViewer: menu to invert rotations and set auto rotation (#11206) 8 months ago
kodev lint: fix issues reported by newer shellcheck / shfmt 1 month ago
reader.lua Reader: use existing module instances on start (#11485) 5 months ago
setupkoenv.lua tweaks for new build system 2 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