|59a0139a60||1 day ago|
|.ci||10 months ago|
|.circleci||10 months ago|
|.github||4 months ago|
|base@f16948b6c7||1 week ago|
|doc||6 months ago|
|frontend||1 day ago|
|l10n@a8870e59db||2 weeks ago|
|metadata||5 months ago|
|platform||1 month ago|
|plugins||3 days ago|
|resources||3 weeks ago|
|spec/unit||1 day ago|
|test@86eeb0b43d||7 years ago|
|tools||2 months ago|
|.busted||8 years ago|
|.codecov.yml||4 years ago|
|.editorconfig||7 years ago|
|.gitignore||3 years ago|
|.gitmodules||2 years ago|
|.luacheckrc||6 months ago|
|.luacov||5 years ago|
|.shellcheckrc||3 years ago|
|.travis.yml||6 years ago|
|COPYING||9 years ago|
|Makefile||5 months ago|
|README.md||2 months ago|
|datastorage.lua||1 month ago|
|defaults.lua||5 months ago|
|kodev||2 months ago|
|reader.lua||4 weeks ago|
|setupkoenv.lua||1 year ago|
KOReader is a document viewer primarily aimed at e-ink readers.
Download • User guide • Wiki • Developer docs
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, RTF, HTML, CHM, TXT). Scanned PDF/DjVu documents can also be reflowed with the built-in K2pdfopt library. ZIP files are also supported for some formats.
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.
Please follow the model specific steps for your device:
Android • Cervantes • Kindle • Kobo • Linux • Pocketbook • reMarkable
Setting up a build environment • Collaborating with Git • Building targets • Porting • Developer docs
KOReader is developed and supported by volunteers all around the world. There are many ways you can help:
- fix bugs and implement new features
- translate the program into your language or improve an existing translation
- document lesser-known features on the wiki
- help others with your knowledge on the forum
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.