2
0
mirror of https://github.com/koreader/koreader synced 2024-10-31 21:20:20 +00:00
Go to file
2019-10-27 18:30:39 +01:00
.ci [chore] Convert a couple more todos (#5267) 2019-08-26 15:49:50 +02:00
.circleci [CI] Switch to custom xgettext build to extract multiline strings (#5242) 2019-08-22 17:11:47 +02:00
.github ISSUE_TEMPLATE: add request to share crash.log (#3296) 2017-10-04 17:22:08 +02:00
base@2700c5315d Bump base (#5536) 2019-10-26 22:16:04 +02:00
doc Minor dev documentatioon tweaks (#5518) 2019-10-22 01:25:00 +02:00
frontend [fix] Handle max_width in time widget (#5540) 2019-10-27 18:30:39 +01:00
l10n@c848073a4c [i18n, fix] Update l10n dir with initialized Transifex (#5531) 2019-10-25 18:35:54 +02:00
platform android: fix ko paths when primary storage is a SD card 2019-10-14 09:11:58 +02:00
plugins [statistic plugin] Don't generate md5 sum on open document (#5528) 2019-10-26 09:08:57 +02:00
resources Unify battery meters look'n feel (#5537) 2019-10-27 05:22:17 +01:00
spec/unit Unify battery meters look'n feel (#5537) 2019-10-27 05:22:17 +01: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 [chore] Add translations to submodule (#5506) 2019-10-19 15:18:50 +02:00
.gitmodules [chore] Add translations to submodule (#5506) 2019-10-19 15:18:50 +02:00
.luacheckrc [UX] Option to show progress bar at the bottom of the screen (#5442) 2019-10-10 17:02:28 +02:00
.luacov [CI] Also run coverage on plugins (#3447) 2017-10-29 21:09:13 +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 [build] Add support for Debian packages (#4434) 2019-01-03 18:21:35 +01:00
defaults.lua remove unused ANDROID_FONT_DIR and update defaults.spec 2019-10-14 09:11:58 +02:00
kodev [fix] kodev: Allow nightly build to succeed (#5507) 2019-10-19 17:45:49 +02:00
Makefile [fix] kodev: Allow nightly build to succeed (#5507) 2019-10-19 17:45:49 +02:00
reader.lua Fix debug logging in the framebuffer module 2019-09-12 14:27:05 +02:00
README.md (test master branch protection - please ignore) 2019-10-23 00:17:35 +02: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

DownloadWikiDeveloper docs

Main features

  • portable: runs on embedded devices (Cervantes, Kindle, Kobo, PocketBook), 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:

AndroidCervantesKindleKoboLinuxPocketbook

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:

At this moment we don't support any form of monetary donation, but you can create a bounty for the specific bug or feature request you want and motivate others to do the work.

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