2
0
mirror of https://github.com/koreader/koreader synced 2024-11-04 12:00:25 +00:00
Go to file
2022-08-03 09:51:57 -04: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 [CI] Downgrade macOS Github Action to macOS 10.15 (#9279) 2022-07-04 12:17:33 +02:00
base@e3e0e3f38b bump crengine: monospace and fallback fonts tweaks (#9343) 2022-07-18 01:16:51 +02:00
doc [doc] Update busted version mentioned in docs (#9078) 2022-05-07 18:22:55 +02:00
frontend Highlight: add note marker (#9395) 2022-08-03 09:51:57 -04:00
l10n@f18f0e5dd4 Update translations for 2022.07 (#9394) 2022-07-31 09:06:15 +02:00
metadata/en-US F-Droid description: tame expectations (#8178) 2021-09-04 21:26:28 +02:00
platform bump android-luajit-launcher (#9386) 2022-07-31 09:02:57 +02:00
plugins BookMap: allow tap on ToC titles and outside page slots (#9400) 2022-08-03 08:45:45 +02:00
resources Keyboard: add Bengali Probhat layout (#8887) 2022-03-15 23:13:13 +01:00
spec/unit SystemStat: Show awake/suspend/standby breakdown in % (#9257) 2022-06-27 21:16:51 +02:00
test@86eeb0b43d various test/coverage optimization 2016-08-15 00:32:40 +08:00
tools keyboard: japanese: always put digits as the south gesture for latin (#8443) 2021-11-14 14:10:25 +01: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 add basic metadata for F-Droid 2021-06-17 21:54:03 +02:00
.luacheckrc luacheckrc: allow busted's "match" global for spec/ (#8369) 2021-10-24 15:31:22 +02:00
.luacov [CI] Also run coverage on plugins (#3447) 2017-10-29 21:09:13 +01: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
datastorage.lua Fix koreader not using XDG_CONFIG_HOME on linux (#8507) 2021-12-05 21:16:22 +01:00
defaults.lua Raise DocumentCache hard cap to 512MB 2021-08-19 22:40:04 +02:00
kodev Bump android backend (#7813) 2021-06-07 17:13:34 +02:00
Makefile userpatch: allow monkey-patching KOReader (#9104) 2022-06-25 22:46:43 +02:00
reader.lua userpatch: allow monkey-patching KOReader (#9104) 2022-06-25 22:46:43 +02:00
README.md Readme: Tame down expectations (#8177) 2021-09-04 11:54:30 +02: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, CHM, TXT). Scanned PDF/DjVu documents can also be reflowed with the built-in K2pdfopt library.

  • 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