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
poire-z 6132e8c904 Button: don't handle long-press when not enabled
It was only not handled when hold_callback. Do that
also when hold_input/hold_input_func.
Also fix the handling of HoldRelease (as the Hold may
change the state of 'enabled', so we can't rely
on it to guess the Hold is being handled by Button).
Menu: prevent long-press on "No choice available",
as there's then no page to navigate to.
3 years ago
.ci CI: Update to Busted 2.0.0 3 years ago
.circleci [chore] (#6764) 4 years ago
.github kodev: Use getopt instead of a hand-rolled hack (#6980) 3 years ago
base@d980ec9c48 Bump base (#7295) 3 years ago
doc Emulator: update mac instructions to include gnu grep (#7266) 3 years ago
frontend Button: don't handle long-press when not enabled 3 years ago
l10n@a8509c1559 Update translations for 2021.02 (#7287) 3 years ago
metadata@98fd6c8fe0 add metadata, to be used by fdroid 4 years ago
platform Remarkable1 wifi (#7216) 3 years ago
plugins File browser settings: reorganize into Settings submenu (#7259) 3 years ago
resources Page Overlap: Fix rectangle computation and arrow mode (#7269) 3 years ago
spec/unit move opds to plugin (#7237) 3 years ago
test@86eeb0b43d various test/coverage optimization 8 years ago
tools Remove PNG icons, add koreader.svg 3 years 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 add metadata, to be used by fdroid 4 years ago
.luacheckrc Update UI layout code to use new SVG icons 3 years ago
.luacov [CI] Also run coverage on plugins (#3447) 7 years ago
.shellcheckrc [CI] Add curly braces check (#5809) 4 years ago
.travis.yml quickstart fix (#2804) 7 years ago
COPYING switch license to AGPLv3 10 years ago
Makefile Remove PNG icons, add koreader.svg 3 years ago
README.md Remove sourceror.io (#6986) 3 years ago
datastorage.lua [CI] Mac OS app (#6955) 3 years ago
defaults.lua Fix y origin of the configmenu extended tapzone (#7015) 3 years ago
kodev reader.lua: rework file/directory argument handling. (#7053) 3 years ago
reader.lua Remember the final rotation during Reboot/PowerOff/AutoSuspend, too (#7133) 3 years ago
setupkoenv.lua A few minor fixes after #4847 (#4850) 5 years 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

DownloadWikiDeveloper 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), Evernote (export hightlights), 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

  • and much more: look up words with StarDict dictionaries / Wikipedia, add your own online OPDS catalogs and RSS feeds, share ebooks with other KOReader devices wirelessly, online over-the-air software updates, an FTP client, an SSH server, …

Please check 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