Home - surefish/koreader GitHub Wiki

You can check out the latest download from the Download page.

WIKI in other languages:

NOTICE: Some of the content on the WIKI might be out of date. Please help make it better by opening an issue if you find any of the instructions unclear or confusing.

Introduction

KOReader is a document viewer for eink devices. The formats it supports include PDF, DjVu, XPS, CBZ, FB2, PDB, TXT, HTML, RTF, CHM, EPUB, DOC, MOBI, and ZIP files.

KOReader is rewritten from kindlepdfviewer, which is originally built by hawhill based on the mupdf source. Since then it has come a long way, based on requests and updates by hackers around the world.

There are related discussion threads on the MobileRead Forums, one of the largest English language web forums for e-book reading/publishing:

For a more thorough division for different devices please take a look at NiLuJe's builds. Here, for instance, you will find KOReader for non-touch Kindles among others too! (weekly-ish builds, not tied to any stable/nightly tag. The device separation stems from the custom, highly device-specific toolchains used).

For Users

Overview:

Getting started:

Plugins:

Advanced:

For Developers

Known problems

See our issue tracker.

Changelog