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 0c17941ffb kopt: color support
Keep colors when reflowing documents.
2 months ago
.ci ci: fix shellchecks helper 3 months ago
.circleci ci/circle: bump docker image (#12166) 2 months ago
.github Update bug_report.md with new location of verbose logging toggle (#12042) 3 months ago
base@7960d305f7 bump base 2 months ago
doc doc: add Arch Linux building instructions (#12090) 3 months ago
frontend kopt: color support 2 months ago
l10n@76f8b999c8
make Add kindlehf target (#11986) 3 months ago
metadata
platform bump android-luajit-launcher (#12147) 2 months ago
plugins exporter: fix remaining OOM (#12126) 3 months ago
resources
spec/unit tests/opds: fix no longer valid feedbooks.com URLs (#12185) 2 months ago
test@86eeb0b43d
tools [minor] Fix lowercase typo in "Google Translate" (#12157) 2 months ago
.busted
.codecov.yml
.editorconfig
.gitignore
.gitmodules
.luacheckrc
.luacov
.luarc.json
.shellcheckrc
COPYING
Makefile tweaks for new build system 4 months ago
README.md
datastorage.lua
defaults.lua
kodev lint: fix issues reported by newer shellcheck / shfmt 3 months ago
reader.lua
setupkoenv.lua tweaks for new build system 4 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