2
0
mirror of https://github.com/koreader/koreader synced 2024-11-04 12:00:25 +00:00
Go to file
2022-10-20 19:35:09 +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 GH: Extend the issue template to request verbose debug logs for non-crash issues. (#9585) 2022-10-05 17:37:33 +02:00
base@fc31b4d98b UIManager: Minor code cleanup (#9641) 2022-10-16 01:43:47 +02:00
doc Cleanup various varargs shenanigans (#9624) 2022-10-12 19:59:48 +02:00
frontend UIManager: Minor code cleanup (#9641) 2022-10-16 01:43:47 +02: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 Cleanup various varargs shenanigans (#9624) 2022-10-12 19:59:48 +02:00
plugins [plugin] AutoStandby: Make "Update" string translatable (#9655) 2022-10-20 19:35:09 +02:00
resources Bump koreader-fonts to unbreak FreeFonts (#9508) 2022-09-11 19:08:35 +02:00
spec/unit UnitTests: Nits and misspellings (#9629) 2022-10-18 15:56:57 +02:00
test@86eeb0b43d
tools Clarify our OOP semantics across the codebase (#9586) 2022-10-06 02:14:48 +02:00
.busted
.codecov.yml
.editorconfig
.gitignore
.gitmodules
.luacheckrc Cleanup various varargs shenanigans (#9624) 2022-10-12 19:59:48 +02:00
.luacov
.shellcheckrc [CI] Add curly braces check (#5809) 2020-02-02 20:35:21 +01:00
.travis.yml
COPYING
datastorage.lua Fix koreader not using XDG_CONFIG_HOME on linux (#8507) 2021-12-05 21:16:22 +01:00
defaults.lua Misc: Get rid of the legacy defaults.lua globals (#9546) 2022-09-28 01:10:50 +02:00
kodev
Makefile Build: Make sure the STL has proper permissions (#9478) 2022-09-05 06:04:52 +02:00
reader.lua Cleanup: Use Lua's native setvbuf wrapper instead of reinventing the wheel (#9636) 2022-10-14 18:44:36 +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