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 4b9de16c51
bump base: libk2pdfopt, fix ffi cdecls, improved ccache (#10638)
- https://github.com/koreader/koreader-base/pull/1619
- https://github.com/koreader/koreader-base/pull/1623
- https://github.com/koreader/koreader-base/pull/1628
1 year ago
.ci
.circleci
.github mac: github actions macos-13 (#10404) 1 year ago
base@b4cfe83c1f bump base: libk2pdfopt, fix ffi cdecls, improved ccache (#10638) 1 year ago
doc Deal with table.pack corner-cases properly (#10350) 1 year ago
frontend ReaderUI: minor optimization (#10634) 1 year ago
l10n@9cf98d3619 Update translations for v2023.06 (#10626) 1 year ago
metadata
platform Bump android/luajit-launcher 1 year ago
plugins Disabled touch input: always active gestures (#10624) 1 year ago
resources Bookmark flipping mode fix (#10196) 2 years ago
spec/unit ReaderUI: minor optimization (#10634) 1 year ago
test@86eeb0b43d
tools
.busted
.codecov.yml
.editorconfig
.gitignore
.gitmodules
.luacheckrc
.luacov
.luarc.json Add a config file for the Lua LSP (#10611) 1 year ago
.shellcheckrc
.travis.yml
COPYING
Makefile PM: Minor refactor to suspend/resume code flow (#10426) 1 year ago
README.md
datastorage.lua DataStorage: fix typo and actually create $HOME/.config if it doesn't exist yet (#10390) 1 year ago
defaults.lua
kodev kodev: Catch TAG_SURFACE in the debug logcat filter (#10431) 1 year ago
reader.lua Version log and (limited) notifications log (#10178) 2 years ago
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, but you can also create a bounty to motivate others to work on a specific bug or feature request.

Contributors

Last commit Commit activity