2
0
mirror of https://github.com/koreader/koreader synced 2024-10-31 21:20:20 +00:00
Go to file
2022-02-19 22:04:12 +01:00
.ci Terminal emulator: full rewrite, real vt52 emulator (#8636) 2022-01-28 20:33:09 +01:00
.circleci [CI] Fix CircleCI context issue by separating out docs & translations (#8614) 2022-01-04 22:17:40 +01:00
.github [CI] Update macOS GitHub Action to macOS 11 (#8525) 2021-12-26 13:27:10 +01:00
base@91c1285b7e Fix invert for pocketbooks by disabling hardware invert (#8803) 2022-02-19 19:50:52 +01:00
doc Fix docs, evernote → exporter (#8158) 2021-08-31 09:51:12 +02:00
frontend warning on file size over 400000 b 2022-02-19 22:04:12 +01:00
l10n@9010e7d8e7 Update translations for 2022.01 (#8676) 2022-01-16 10:48:44 +01:00
metadata/en-US F-Droid description: tame expectations (#8178) 2021-09-04 21:26:28 +02:00
platform Bump android-luajit-launcher 2022-02-08 00:25:13 +01:00
plugins gestures: free long-press on FM home button 2022-02-19 22:04:12 +01:00
resources ImageViewer: update to TitleBar widget 2022-01-10 19:59:11 +01:00
spec/unit [autosuspend, plugin] Switch to datetimewidget and provide default values (#8480) 2021-11-28 22:18:44 +01: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 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 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 switch license to AGPLv3 2014-03-23 16:53:05 +08:00
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 Bump android backend (#7813) 2021-06-07 17:13:34 +02:00
reader.lua FileManager/ReaderUI: Clarify the current instance accessor (#7658) 2021-05-11 00:49:35 +02:00
README.md Readme: Tame down expectations (#8177) 2021-09-04 11:54:30 +02:00
setupkoenv.lua Truly silence the attempt at loading SDL2 2021-05-19 20:55:00 +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, 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