2
0
mirror of https://github.com/koreader/koreader synced 2024-11-04 12:00:25 +00:00
Go to file
2023-03-12 08:35:16 +01:00
.ci [CI] Don't hide docs generation log (#9204) 2022-06-12 13:37:07 +02:00
.circleci [CI] Also use Ubuntu 20.04 Docker image for docs (#9209) 2022-06-13 18:39:23 +02:00
.github Revert "[CI] Set macOS Github Action to macOS 12.00 (#9856)" (#9864) 2022-12-06 08:46:11 +01:00
base@acba4023f9 bump crengine: optimizations, fixes, View HTML helpers 2023-03-05 23:42:24 +01:00
doc Cleanup various varargs shenanigans (#9624) 2022-10-12 19:59:48 +02:00
frontend Classic display mode: add popup file dialog buttons (#10185) 2023-03-07 22:24:42 +02:00
l10n@fc475cd27b Update translations for v2023.01 (#10061) 2023-01-31 20:37:53 +01:00
metadata update metadata & translations 2022-10-23 10:26:20 +02:00
platform Bump luajit-launcher for Onyx Poke 4 lite (#10137) 2023-02-22 14:00:05 +01:00
plugins vocabbuilder: fix reset word progress bug (#10195) 2023-03-12 08:35:16 +01:00
resources CoverBrowser Mosaic: improve book status, floating progress bar (#9939) 2023-02-17 21:29:53 +01:00
spec/unit Datastorage: do not create unnecessary folders (#10162) 2023-03-02 08:39:09 +02:00
test@86eeb0b43d
tools [fix] kodev wbuilder crashes with "attempt to index global 'G_defaults' (a nil value)" (#10088) 2023-02-07 09:08:28 +01:00
.busted
.codecov.yml
.editorconfig
.gitignore
.gitmodules add basic metadata for F-Droid 2021-06-17 21:54:03 +02:00
.luacheckrc Cleanup various varargs shenanigans (#9624) 2022-10-12 19:59:48 +02:00
.luacov
.shellcheckrc
.travis.yml
COPYING
datastorage.lua Datastorage: do not create unnecessary folders (#10162) 2023-03-02 08:39:09 +02:00
defaults.lua Cleanup: Track color constant name change (#9716) 2022-10-30 22:34:48 +01:00
kodev kodev: fix grep: warning: stray \ before - (#10071) 2023-02-03 13:45:23 +01:00
Makefile Support Android AArch64 (#9645) 2022-10-25 01:54:18 +02:00
reader.lua Version log and (limited) notifications log (#10178) 2023-03-05 15:21:56 +01:00
README.md Readme: update list of supported formats (#10004) 2023-02-12 23:23:59 +01:00
setupkoenv.lua setupkoenv: ffi.load: search rocks 2022-03-08 10:36:00 -05: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

DownloadUser guideWikiDeveloper 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, RTF, HTML, CHM, TXT). Scanned PDF/DjVu documents can also be reflowed with the built-in K2pdfopt library. ZIP files are also supported for some formats.

  • 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), 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

  • fast: on some older devices, it has been measured to have less than half the page-turn delay as the built in reading software.

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

Please check the user guide and 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