2
0
mirror of https://github.com/koreader/koreader synced 2024-11-13 19:11:25 +00:00
Go to file
2023-07-09 08:13:13 +02: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 mac: github actions macos-13 (#10404) 2023-05-14 15:02:01 -04:00
base@9b5cf240bf Decrease fonts memory use (#10618) 2023-07-04 09:13:16 +02:00
doc Deal with table.pack corner-cases properly (#10350) 2023-04-24 00:21:05 +02:00
frontend QuickMenu: anchor to gesture position 3 (#10646) 2023-07-08 08:17:42 +03:00
l10n@6fe9e0ea24 Update translations for v2023.06.1 (#10665) 2023-07-09 08:13:13 +02:00
metadata update metadata & translations 2022-10-23 10:26:20 +02:00
platform Bump android/luajit-launcher 2023-07-03 01:22:41 +02:00
plugins QuickMenu: anchor to gesture position 3 (#10646) 2023-07-08 08:17:42 +03:00
resources Bookmark flipping mode fix (#10196) 2023-03-13 09:52:10 +02:00
spec/unit Decrease fonts memory use (#10618) 2023-07-04 09:13:16 +02:00
test@86eeb0b43d various test/coverage optimization 2016-08-15 00:32:40 +08:00
tools [fix] kodev wbuilder crashes with "attempt to index global 'G_defaults' (a nil value)" (#10088) 2023-02-07 09:08:28 +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 add basic metadata for F-Droid 2021-06-17 21:54:03 +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
.travis.yml quickstart fix (#2804) 2017-04-24 08:27:29 +02:00
COPYING switch license to AGPLv3 2014-03-23 16:53:05 +08:00
datastorage.lua DataStorage: fix typo and actually create $HOME/.config if it doesn't exist yet (#10390) 2023-05-04 20:31:14 +02:00
defaults.lua Cleanup: Track color constant name change (#9716) 2022-10-30 22:34:48 +01:00
kodev kodev: Catch TAG_SURFACE in the debug logcat filter (#10431) 2023-05-13 20:39:11 +02:00
Makefile PM: Minor refactor to suspend/resume code flow (#10426) 2023-05-18 23:13:43 +02:00
reader.lua Version log and (limited) notifications log (#10178) 2023-03-05 15:21:56 +01:00
README.md Readme: update list of supported formats (#10004) 2023-02-12 23:23:59 +01:00
setupkoenv.lua setupkoenv: ffi.load: search rocks 2022-03-08 10:36:00 -05: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