2
0
mirror of https://github.com/koreader/koreader synced 2024-10-31 21:20:20 +00:00
Go to file
2020-11-29 10:19:47 +01:00
.ci Kobo, Mk.5: Tweak CPU frequency scaling (#6905) 2020-11-25 15:50:47 +01:00
.circleci [chore] (#6764) 2020-10-09 19:15:16 +02:00
.github bug template: [android] log native crashes too (#6920) 2020-11-28 17:48:03 +01:00
base@7f96b5dfb2 CoverImage plugin: allow saving covers as BMP (#6904) 2020-11-28 13:57:33 +01:00
doc [fix] Minor doc touchups re. QR encode (#6861) 2020-11-09 09:17:11 +01:00
frontend switch between internal and external sdcard 2020-11-29 10:19:47 +01:00
l10n@718d53ce42 Paged documents: rework zoom options (#6885) 2020-11-28 17:18:57 +01:00
metadata@98fd6c8fe0 add metadata, to be used by fdroid 2020-01-02 01:29:28 +01:00
platform Kobo: Warn on restart if the startup script is outdated (#6916) 2020-11-28 22:48:09 +01:00
plugins AutoSave: Delay I/O until after the pageturn (#6917) 2020-11-28 22:59:27 +01:00
resources Paged documents: rework zoom options (#6885) 2020-11-28 17:18:57 +01:00
spec/unit Devices: get rid of touch_probe_ev_epoch_time 2020-10-18 20:13:44 +02:00
test@86eeb0b43d
tools [fix] Add CanvasContext to wbuilder (#5287) 2019-08-31 14:13:34 +02:00
.busted
.codecov.yml [CI] Add .codecov.yml (#4695) 2019-03-01 17:29:04 +01:00
.editorconfig
.gitignore Add macOS target 2020-07-11 01:29:49 +02:00
.gitmodules add metadata, to be used by fdroid 2020-01-02 01:29:28 +01:00
.luacheckrc Tame BackgroundRunner: stop running when no more job (#6605) 2020-08-31 16:48:29 +02:00
.luacov
.shellcheckrc [CI] Add curly braces check (#5809) 2020-02-02 20:35:21 +01:00
.travis.yml
COPYING
datastorage.lua Create ota dir (#6857) 2020-11-08 09:19:13 +01:00
defaults.lua unified calibre plugin (#6177) 2020-06-19 12:22:38 +02:00
kodev Add macOS target 2020-07-11 01:29:49 +02:00
Makefile Android bundle update (#6870) 2020-11-13 00:50:24 +01:00
reader.lua Clean up C blitbuffer kludges. (#6696) 2020-09-22 23:26:05 +02:00
README.md Remove PB hardware requests (#6767) 2020-10-08 15:56:09 +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 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