You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Steady Quad fa9f0acf5e
cloudstorage: Fix directory listing for some WebDAV servers (#9847)
23 hours ago
.ci [CI] Don't hide docs generation log (#9204) 6 months ago
.circleci [CI] Also use Ubuntu 20.04 Docker image for docs (#9209) 6 months ago
.github [CI] Set macOS Github Action to macOS 12.00 (#9856) 1 day ago
base@91a58d3e39 bump base: LunaSVG: various upstream fixes, fix edge pixels bleeding (#9858) 1 day ago
doc Cleanup various varargs shenanigans (#9624) 2 months ago
frontend cloudstorage: Fix directory listing for some WebDAV servers (#9847) 23 hours ago
l10n@2a917c2380 Update translations for v2022.11 (#9851) 3 days ago
metadata update metadata & translations 1 month ago
platform Kobo: Unbreak KSM detection 3 weeks ago
plugins [plugin] AutoWarmth: cleanup code (#9788) 1 day ago
resources ReaderHighlight: add abort select mode (#9786) 2 weeks ago
spec/unit [StatusBar] Allow status bars to be repainted if they are not covered (#9768) 2 weeks ago
test@86eeb0b43d various test/coverage optimization 6 years ago
tools InputContainer: Fall cleanup ;). 1 month ago
.busted Travis update 7 years ago
.codecov.yml [CI] Add .codecov.yml (#4695) 4 years ago
.editorconfig experimental port to Mac OSX 7 years ago
.gitignore Add macOS target 2 years ago
.gitmodules add basic metadata for F-Droid 1 year ago
.luacheckrc Cleanup various varargs shenanigans (#9624) 2 months ago
.luacov [CI] Also run coverage on plugins (#3447) 5 years ago
.shellcheckrc [CI] Add curly braces check (#5809) 3 years ago
.travis.yml quickstart fix (#2804) 6 years ago
COPYING switch license to AGPLv3 9 years ago
Makefile Support Android AArch64 (#9645) 1 month ago
README.md Readme: Tame down expectations (#8177) 1 year ago
datastorage.lua Fix koreader not using XDG_CONFIG_HOME on linux (#8507) 1 year ago
defaults.lua Cleanup: Track color constant name change (#9716) 1 month ago
kodev Support Android AArch64 (#9645) 1 month ago
reader.lua [i18n] Fix Arabic translations (#9857) 1 day ago
setupkoenv.lua setupkoenv: ffi.load: search rocks 9 months ago

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

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