2
0
mirror of https://github.com/koreader/koreader synced 2024-11-11 19:11:14 +00:00
Go to file
2024-04-19 01:04:49 +02:00
.ci ci: remove CircleCI unnecessary steps 2024-04-16 18:58:45 +02:00
.circleci ci: cleanup CircleCI fetch phases 2024-04-16 18:58:45 +02:00
.github [CI] Bump actions/upload-artifact from 3 to 4 (#11242) 2023-12-18 11:13:00 +01:00
base@781db25317 bump base, luajit-launcher, avoid assert failure in sub-processes (#11658) 2024-04-10 22:39:59 +02:00
doc doc: remove ragel from the build requirements (#11661) 2024-04-10 23:30:52 +02:00
frontend Add PocketBook Era Color (PB700K3) 2024-04-19 01:04:49 +02:00
l10n@7e75ac4b28 Update translations for v2024.03 (#11508) 2024-03-03 11:11:09 +01:00
metadata update metadata & translations 2022-10-23 10:26:20 +02:00
platform bump base, luajit-launcher, avoid assert failure in sub-processes (#11658) 2024-04-10 22:39:59 +02:00
plugins NewsDownloader: use <content:encoded> from RSS item, if available (#11694) 2024-04-18 13:24:08 +02:00
resources Bookmark flipping mode fix (#10196) 2023-03-13 09:52:10 +02:00
spec/unit ReaderZooming: make auto-crop default be page content (#11438) 2024-03-14 00:15:10 +01:00
test@86eeb0b43d various test/coverage optimization 2016-08-15 00:32:40 +08:00
tools Chore: Review FrameContainer constructors for shared dimen objects 2024-01-19 00:08:10 +01:00
.busted Travis update 2015-08-24 16:40:52 +02:00
.codecov.yml [CI] Add .codecov.yml (#4695) 2019-03-01 17:29:04 +01:00
.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 [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 switch license to AGPLv3 2014-03-23 16:53:05 +08:00
datastorage.lua DocSettings: check legacy history location only once (#11439) 2024-02-06 08:44:37 +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 make: speedup fetchthirdparty 2024-04-16 18:58:45 +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 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.

Contributors

Last commit Commit activity