2
0
mirror of https://github.com/koreader/koreader synced 2024-11-10 01:10:34 +00:00
Go to file
Benoit Pierre 9162a8d69c ci/macos: drop Python setup
We don't need it (not yet, since we don't use meson).
2024-07-19 22:43:42 +02:00
.ci ci: fix shellchecks helper 2024-06-15 23:02:52 +02:00
.circleci ci/circle: bump docker image (#12166) 2024-07-15 19:53:09 +02:00
.github ci/macos: drop Python setup 2024-07-19 22:43:42 +02:00
base@d77bf32aa5 bump base: updated build system 2024-07-19 22:43:42 +02:00
doc doc: add Arch Linux building instructions (#12090) 2024-06-26 12:03:25 +02:00
frontend ReaderThumbnail: clear cache on rendering mode change 2024-07-19 21:32:20 +02:00
l10n@76f8b999c8 Update translations for v2024.04 (#11726) 2024-04-27 23:19:13 +02:00
make Add kindlehf target (#11986) 2024-06-11 18:34:03 +02:00
metadata update tool to generate metadata translations (#11869) 2024-05-26 20:10:12 +02:00
platform bump android-luajit-launcher (#12147) 2024-07-07 23:03:46 +02:00
plugins exporter: fix remaining OOM (#12126) 2024-07-03 21:55:42 +02:00
resources Collections: add collection mark to books (#11868) 2024-05-26 08:18:44 +03:00
spec/unit djvu: honor render mode when reflowing 2024-07-19 21:32:20 +02:00
test@86eeb0b43d
tools [minor] Fix lowercase typo in "Google Translate" (#12157) 2024-07-11 22:53:23 +02:00
.busted
.codecov.yml
.editorconfig experimental port to Mac OSX 2016-04-22 20:13:44 +08:00
.gitignore Add macOS target 2020-07-11 01:29:49 +02:00
.gitmodules l10n: mark git submodule for shallow updates 2024-04-16 18:58:45 +02:00
.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
COPYING switch license to AGPLv3 2014-03-23 16:53:05 +08:00
datastorage.lua SDL: add flatpak flavor (#11833) 2024-05-18 13:21:59 +02:00
defaults.lua ImageViewer: menu to invert rotations and set auto rotation (#11206) 2023-12-12 13:24:31 +01:00
kodev lint: fix issues reported by newer shellcheck / shfmt 2024-06-15 23:02:52 +02:00
Makefile tweaks for new build system 2024-05-29 22:02:06 +02:00
reader.lua Reader: use existing module instances on start (#11485) 2024-02-24 09:24:50 +02:00
README.md Remove bountysource from README (#11385) 2024-03-03 14:02:52 +01:00
setupkoenv.lua tweaks for new build system 2024-05-29 22:02:06 +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.

Contributors

Last commit Commit activity