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.
 
 
 
 
Martín Fernández 4345201e0e
[CI] Mac OS app (#6955)
11 months ago
.ci Kobo, Mk.5: Tweak CPU frequency scaling (#6905) 1 year ago
.circleci [chore] (#6764) 1 year ago
.github [CI] Mac OS app (#6955) 11 months ago
base@b7e8c15e2c move unpackArchive to Device, use native version on android (#6959) 11 months ago
doc [fix] Minor doc touchups re. QR encode (#6861) 1 year ago
frontend Some RTL UI fix up after #6885 (#6975) 11 months ago
l10n@718d53ce42 Paged documents: rework zoom options (#6885) 1 year ago
metadata@98fd6c8fe0 add metadata, to be used by fdroid 1 year ago
platform [CI] Mac OS app (#6955) 11 months ago
plugins FileManager: fix Plus menu override (#6957) 11 months ago
resources Paged documents: rework zoom options (#6885) 1 year ago
spec/unit [RFC] Make default UI tapzones more generous (#6918) 1 year ago
test@86eeb0b43d various test/coverage optimization 5 years ago
tools [fix] Add CanvasContext to wbuilder (#5287) 2 years ago
.busted Travis update 6 years ago
.codecov.yml [CI] Add .codecov.yml (#4695) 2 years ago
.editorconfig experimental port to Mac OSX 5 years ago
.gitignore Add macOS target 1 year ago
.gitmodules add metadata, to be used by fdroid 1 year ago
.luacheckrc [RFC] Make default UI tapzones more generous (#6918) 1 year ago
.luacov [CI] Also run coverage on plugins (#3447) 4 years ago
.shellcheckrc [CI] Add curly braces check (#5809) 1 year ago
.travis.yml quickstart fix (#2804) 4 years ago
COPYING switch license to AGPLv3 7 years ago
Makefile Quote PATH (#6948) 1 year ago
README.md Remove PB hardware requests (#6767) 1 year ago
datastorage.lua [CI] Mac OS app (#6955) 11 months ago
defaults.lua [RFC] Make default UI tapzones more generous (#6918) 1 year ago
kodev kodev: Make the directory finding code work as intended (probably?) (#6935) 1 year ago
reader.lua Clean up C blitbuffer kludges. (#6696) 1 year ago
setupkoenv.lua A few minor fixes after #4847 (#4850) 2 years 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

DownloadWikiDeveloper 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), Evernote (export hightlights), 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

  • and much more: look up words with StarDict dictionaries / Wikipedia, add your own online OPDS catalogs and RSS feeds, share ebooks with other KOReader devices wirelessly, online over-the-air software updates, an FTP client, an SSH server, …

Please check 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

0 1 2 3 4 5 6 7