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 74c1813a82 GestureDetector: add Tap interval on keyboard setting
Follow up to b90f6db8: allow specifying an other
value for tap interval when the keyboard is shown
(a good value for tap interval on reader and UI
elements might be too long on the keyboard, and
prevent typing fast).
4 years ago
.ci [CI] Update shellcheck URL (#6445) 4 years ago
.circleci [chore] (#6764) 4 years ago
.github Add FR template (#6296) 4 years ago
base@444a70965a bump crengine: upstream sync, some rendering fixes (#6837) 4 years ago
doc ldoc fixes 4 years ago
frontend GestureDetector: add Tap interval on keyboard setting 4 years ago
l10n@3238f54991 [i18n] Bump translations for 2020.10 release (#6776) 4 years ago
metadata@98fd6c8fe0 add metadata, to be used by fdroid 5 years ago
platform Pocketbook: Use a single launcher (#6814) 4 years ago
plugins GestureDetector: add Tap interval on keyboard setting 4 years ago
resources Update fonts (#6744) 4 years ago
spec/unit Devices: get rid of touch_probe_ev_epoch_time 4 years ago
test@86eeb0b43d various test/coverage optimization 8 years ago
tools [fix] Add CanvasContext to wbuilder (#5287) 5 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 5 years ago
.luacheckrc Tame BackgroundRunner: stop running when no more job (#6605) 4 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 Pocketbook: Use a single launcher (#6814) 4 years ago
README.md Remove PB hardware requests (#6767) 4 years ago
datastorage.lua android: unbreak KO on scoped storage devices 5 years ago
defaults.lua unified calibre plugin (#6177) 4 years ago
kodev Add macOS target 4 years ago
reader.lua Clean up C blitbuffer kludges. (#6696) 4 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

0 1 2 3 4 5 6 7