You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Go to file
Frans de Jonge 343eff3123
Update translations reference for release (#5797)
4 years ago
.ci [chore] Prevent useless POT updates (#5734) 4 years ago
.circleci [CI] Docker koreader/koappimage:0.1.7 for ragel (#5753) 4 years ago
.github Add Liberapay link (#5770) 4 years ago
base@9751e5ae73 TextWidget: adds getFittedText() (#5776) 4 years ago
doc [doc] Add ragel to build prerequisites (#5743) 4 years ago
frontend Footer: extend min and max values for font size (#5796) 4 years ago
l10n@235c636fe1 Update translations reference for release (#5797) 4 years ago
metadata@98fd6c8fe0 add metadata, to be used by fdroid 4 years ago
platform fix #5781 4 years ago
plugins [fix, plugin] Evernote exporter only writes one documents clippings when txt export used, rest is ignored (#5774) 4 years ago
resources [RFC] Switch remaining keyboard icons to glyphs (#5639) 4 years ago
spec/unit [fix, plugin] Evernote exporter only writes one documents clippings when txt export used, rest is ignored (#5774) 4 years ago
test@86eeb0b43d various test/coverage optimization 8 years ago
tools [fix] Add CanvasContext to wbuilder (#5287) 5 years ago
.busted Travis update 9 years ago
.codecov.yml [CI] Add .codecov.yml (#4695) 5 years ago
.editorconfig experimental port to Mac OSX 8 years ago
.gitignore [chore] Add translations to submodule (#5506) 5 years ago
.gitmodules add metadata, to be used by fdroid 4 years ago
.luacheckrc Remove DSCROLL_MODE and DGLOBALGAMMA (#5754) 4 years ago
.luacov [CI] Also run coverage on plugins (#3447) 7 years ago
.travis.yml quickstart fix (#2804) 7 years ago
COPYING switch license to AGPLv3 10 years ago
Makefile Unbreak OTA on Kindle (#5758) 4 years ago
README.md Finish Weblate migration (#5713) 4 years ago
datastorage.lua android: unbreak KO on scoped storage devices 4 years ago
defaults.lua Remove DSCROLL_MODE and DGLOBALGAMMA (#5754) 4 years ago
kodev transifex -> weblate fixes (#5722) 4 years ago
reader.lua reader.lua: re-order touchScreenProbe() after CanvasContext 4 years ago
setupkoenv.lua A few minor fixes after #4847 (#4850) 5 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), 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:

AndroidCervantesKindleKoboLinuxPocketbook

Development

Setting 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:

At this moment we don't support any form of monetary donation, but you can create a bounty for the specific bug or feature request you want and motivate others to do the work.

Also if you have and old Pocketbook device you don't want, we might find it useful to tinker a bit with that platform. Please contact us through the forum or GitHub.

Contributors

Last commit Commit activity

0 1 2 3 4 5 6 7