2
0
mirror of https://github.com/koreader/koreader synced 2024-11-10 01:10:34 +00:00
Go to file
2024-08-11 17:31:10 +02:00
.ci make: fix testfront rule 2024-07-31 08:45:48 +02:00
.circleci make: directly include base main makefile 2024-07-31 08:45:48 +02:00
.github ci/macos: update binaries dump & check 2024-08-02 18:46:29 +02:00
base@3c3f18f27a make: improve android update 2024-08-10 23:34:17 +02:00
doc doc: update building documentation (#12295) 2024-08-05 13:00:38 +02:00
frontend BookInfo: rating, review (#12313) 2024-08-11 17:01:15 +03:00
l10n@7bddf3c874 bump translations (#12193) 2024-07-20 19:18:52 +02:00
make make: reword comment 2024-08-11 17:31:10 +02:00
metadata update tool to generate metadata translations (#11869) 2024-05-26 20:10:12 +02:00
platform make: improve android update 2024-08-10 23:34:17 +02:00
plugins [AutoWarmth] Delay front light actions after resume (#12315) 2024-08-09 19:42:13 +02:00
resources Collections: add collection mark to books (#11868) 2024-05-26 08:18:44 +03:00
spec/unit ReaderFooter: improve (#12243) 2024-08-01 13:11:28 +03:00
test@86eeb0b43d
tools [minor] Fix lowercase typo in "Google Translate" (#12157) 2024-07-11 22:53:23 +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 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 [CI] Also run coverage on plugins (#3447) 2017-10-29 21:09:13 +01:00
.luarc.json Add a config file for the Lua LSP (#10611) 2023-06-25 16:14:01 +02:00
.shellcheckrc [CI] Add curly braces check (#5809) 2020-02-02 20:35:21 +01:00
COPYING
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 make: improve android update 2024-08-10 23:34:17 +02:00
Makefile make: improve android update 2024-08-10 23:34:17 +02:00
reader.lua Kobo: Refactor various aspects of the Kaleido/MTK support (#12221) 2024-07-28 01:19:40 +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