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
David f330593233
Fixing button invert on start (#11982)
fixing issue described here https://github.com/koreader/koreader/pull/11963#issuecomment-2147876605
4 months ago
.ci
.circleci
.github ci/macos: dump binaries runtime path & dependencies 4 months ago
base@22a6e4f616 bump base, unbreak MuPDF edition (#11974) 4 months ago
doc
frontend Fixing button invert on start (#11982) 4 months ago
l10n@76f8b999c8
make
metadata
platform kopt: honor `TESSDATA_PREFIX` environment variable 4 months ago
plugins mosaicmenu: fix collection mark (#11969) 4 months ago
resources
spec/unit mupdf: update to 1.24.2 (#11940) 4 months ago
test@86eeb0b43d
tools
.busted
.codecov.yml [CI] Add .codecov.yml (#4695) 6 years ago
.editorconfig
.gitignore
.gitmodules
.luacheckrc
.luacov
.luarc.json
.shellcheckrc
COPYING
Makefile
README.md
datastorage.lua
defaults.lua
kodev bump base: update tesseract, leptonica and libk2pdfopt 4 months ago
reader.lua
setupkoenv.lua

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