2
0
mirror of https://github.com/koreader/koreader synced 2024-11-16 06:12:56 +00:00
Go to file
Mihai Vasiliu 5d2a441064
Add viewport for PB743K3 (#11302)
The bezel covers a couple of pixels of the screen, so adjust not to show content under the bezel.
2023-12-29 17:41:53 +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 [CI] Bump actions/upload-artifact from 3 to 4 (#11242) 2023-12-18 11:13:00 +01:00
base@d83148b27e Bump base 2023-12-22 23:48:50 +01:00
doc [doc] Building targets: remove mentions of Ubuntu Touch (#10974) 2023-10-12 14:46:58 +02:00
frontend Add viewport for PB743K3 (#11302) 2023-12-29 17:41:53 +01:00
l10n@d399f35c4a Update translations for v2023.10 (#11053) 2023-10-30 17:32:04 +01:00
metadata update metadata & translations 2022-10-23 10:26:20 +02:00
platform [android] toggle warmth on onyx devices (#11275) 2023-12-28 12:09:42 +01:00
plugins [plugin] Add folder check in move-to-archive (#11262) 2023-12-27 20:45:16 +01:00
resources Bookmark flipping mode fix (#10196) 2023-03-13 09:52:10 +02:00
spec/unit Kindle: Add a hasLightSensor devcap, and use it in the AutoFrontlight plugin (#11255) 2023-12-24 17:15:30 +01:00
test@86eeb0b43d
tools getProps: centralize 2 (#10837) 2023-08-30 07:53:59 +03:00
.busted
.codecov.yml
.editorconfig
.gitignore
.gitmodules
.luacheckrc Cleanup various varargs shenanigans (#9624) 2022-10-12 19:59:48 +02:00
.luacov
.luarc.json Add a config file for the Lua LSP (#10611) 2023-06-25 16:14:01 +02:00
.shellcheckrc
.travis.yml
COPYING
datastorage.lua Add hash-based document metadata storage option (#10945) 2023-10-11 10:39:33 +02:00
defaults.lua ImageViewer: menu to invert rotations and set auto rotation (#11206) 2023-12-12 13:24:31 +01:00
kodev Never export LD_LIBRARY_PATH 2023-07-18 02:11:25 +02:00
Makefile android: update to use NDK 23c 2023-07-10 22:46:53 +02:00
reader.lua Main: Move the G_reader_settings flush to Device:exit 2023-08-19 17:25:10 +02:00
README.md README: update user guide link (#11000) 2023-10-18 08:50:56 +02:00
setupkoenv.lua Env: Actually use the full ffi.load signature in our overload 2023-07-18 02:11:25 +02: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