Archives/koreader
2
0
Fork 0
mirror of https://github.com/koreader/koreader synced 2024-11-11 19:11:14 +00:00
Code Issues Projects Releases Wiki Activity
10,372 Commits 1 Branch 262 Tags 936 MiB
Lua 97.2%
Shell 2.1%
Makefile 0.3%
Python 0.3%
Erlang 0.1%
89a6ae28a6
Go to file
Martín Fernández 89a6ae28a6
appstream: update metadata (#11851) 
proper requires, supports and recommends
all supported mimetypes
add branding colors
2024-05-19 22:26:58 +02:00
.ci ci/circle: improve caching 2024-05-14 10:33:21 +02:00
.circleci ci: force color output 2024-05-14 10:33:21 +02:00
.github ci/macos: install ninja 2024-05-14 10:33:21 +02:00
base@f9c9316709 Kindle: Don't forget about fiveways on legacy devices & fix a couple input-scan misdetections (#11827) 2024-05-15 23:58:01 +02:00
doc doc: fix android NDK / SDK instructions (#11818) 2024-05-14 12:17:59 +02:00
frontend Shorten home folder path for info messages (#11853) 2024-05-19 13:19:38 +02:00
l10n@76f8b999c8 Update translations for v2024.04 (#11726) 2024-04-27 23:19:13 +02:00
make fix after #11833 (#11849) 2024-05-18 17:47:28 +02:00
metadata bump metadata translations (#11842) 2024-05-17 22:25:32 +02:00
platform appstream: update metadata (#11851) 2024-05-19 22:26:58 +02:00
plugins Replace tweak_buttons_func with an event instead (#11777) 2024-05-16 20:44:01 +02:00
resources Bookmark flipping mode fix (#10196) 2023-03-13 09:52:10 +02:00
spec/unit tests/readerhighlight: speedup 2024-05-09 14:04:57 +02:00
test@86eeb0b43d
tools tools/mk7z: support debian unstable / ubuntu 22.04 2024-05-12 09:47:44 +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 Add generic Linux package (#9351) 2024-05-13 12:11:11 +02:00
Makefile SDL: add flatpak flavor (#11833) 2024-05-18 13:21:59 +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

README.md

KOReader

KOReader is a document viewer primarily aimed at e-ink readers.

AGPL Licence Latest release Gitter Mobileread Build Status Coverage Status Weblate Status

Download • User guide • Wiki • Developer 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:

Android • Cervantes • Kindle • Kobo • Linux • Pocketbook • reMarkable

Development

Setting up a build environment • Collaborating with Git • Building targets • Porting • Developer 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