Koreader, with all the submodules
Find a file
poire-z fc6c786f84
Footer: fix items possibly missing (#6212)
Iterating a k/v table as an array would have us stopped
on the first disabled MODE (frontlight, battery... on
some devices).
Rework that initial setup, and make it correctly handle
added or removed MODEs when using the ordered items
saved in the user settings.
2020-05-30 22:10:32 +02:00
.ci [CI] Add curly braces check (#5809) 2020-02-02 20:35:21 +01:00
.circleci [CI] Docker koreader/koappimage:0.1.7 for ragel (#5753) 2020-01-06 20:45:58 +01:00
.github Add Liberapay link (#5770) 2020-01-15 18:28:17 +01:00
base@4a91eefe3a bump_crengine: various fixes, tweaks and cleanups (#6188) 2020-05-25 22:39:59 +02:00
doc [doc] macOS build info tweaks (#5891) 2020-02-22 09:11:29 +01:00
frontend Footer: fix items possibly missing (#6212) 2020-05-30 22:10:32 +02:00
l10n@b426f63599 [i18n] Bump translations submodule for v2020.05 release (#6158) 2020-05-17 23:03:44 +02:00
metadata@98fd6c8fe0 add metadata, to be used by fdroid 2020-01-02 01:29:28 +01:00
platform [Kindle] Don't resize the titlebar on FW >= 5.12.4 (#6204) 2020-05-29 04:05:07 +02:00
plugins Statistics: some fixes, reordering and rewording (#6194) 2020-05-29 14:22:27 +02:00
resources Update fonts & add Noto Sans Devanagari UI (#5803) 2020-01-31 17:25:13 +01:00
spec/unit Adds Word Expansion: use of letter spacing for justification 2020-05-05 19:06:28 +02:00
test@86eeb0b43d various test/coverage optimization 2016-08-15 00:32:40 +08:00
tools [fix] Add CanvasContext to wbuilder (#5287) 2019-08-31 14:13:34 +02:00
.busted Travis update 2015-08-24 16:40:52 +02:00
.codecov.yml [CI] Add .codecov.yml (#4695) 2019-03-01 17:29:04 +01:00
.editorconfig experimental port to Mac OSX 2016-04-22 20:13:44 +08:00
.gitignore Minor Kobo startup script cleanups (#6102) 2020-04-29 17:50:29 +02:00
.gitmodules add metadata, to be used by fdroid 2020-01-02 01:29:28 +01:00
.luacheckrc Adds Word Expansion: use of letter spacing for justification 2020-05-05 19:06:28 +02:00
.luacov [CI] Also run coverage on plugins (#3447) 2017-10-29 21:09:13 +01:00
.shellcheckrc [CI] Add curly braces check (#5809) 2020-02-02 20:35:21 +01:00
.travis.yml quickstart fix (#2804) 2017-04-24 08:27:29 +02:00
COPYING switch license to AGPLv3 2014-03-23 16:53:05 +08:00
datastorage.lua android: unbreak KO on scoped storage devices 2019-12-12 21:17:03 +01:00
defaults.lua Adds Word Expansion: use of letter spacing for justification 2020-05-05 19:06:28 +02:00
kodev Get rid of the old PB TC (#5860) 2020-02-15 23:49:04 +01:00
Makefile Debian - fix some lintian errors (#6099) 2020-05-14 14:26:00 +02:00
reader.lua Warn if color rendering is enabled on a grayscale device. (#5871) 2020-02-18 02:24:48 +01:00
README.md Add Remarkable to README.md (#5839) 2020-02-12 08:13:11 +01:00
setupkoenv.lua A few minor fixes after #4847 (#4850) 2019-03-29 20:12:09 +01:00

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 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.

Also if you have and old Pocketbook device you don't want, we might find it useful to tinker a bit with that platform. Please contact us through the forum or GitHub.

Contributors

Last commit Commit activity

0 1 2 3 4 5 6 7