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
Hung-Wei Hung 73c8e5c5cd [Kindle] Update Kindle support devices list (#5235)
* Add KT3 into Kindle support list

* Update support list for KT4
5 years ago
.ci [fix, CI] Push to Transifex from master, fix multiline strings for xgettext (#5238) 5 years ago
.circleci [fix, CI] Push to Transifex from master, fix multiline strings for xgettext (#5238) 5 years ago
.github ISSUE_TEMPLATE: add request to share crash.log (#3296) 7 years ago
base@07688a3ce4 bump crengine: CSS parsing: cleanup and optimisations (#5239) 5 years ago
doc [fix] Update LDoc config (#5231) 5 years ago
frontend [fix, CI] Push to Transifex from master, fix multiline strings for xgettext (#5238) 5 years ago
l10n i10n/README: small stylistic changes 7 years ago
platform [Kindle] Update Kindle support devices list (#5235) 5 years ago
plugins [fix, CI] Push to Transifex from master, fix multiline strings for xgettext (#5238) 5 years ago
resources Bump koreader-fonts (#5210) 5 years ago
spec/unit More footer options, default to use icons as prefixes (#5203) 5 years ago
test@86eeb0b43d various test/coverage optimization 8 years ago
tools Various blitting related cleanups (#4789) 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 Ignore all top-level files and dirs `kindle-*` and `*.sdr` 5 years ago
.gitmodules [fix] Switch ubuntu-touch-sdl-template to our own mirror (#5157) 5 years ago
.luacheckrc [statistics] Remove conversion message on new installations (#5120) 5 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 [i18n] Switch `make pot` to xgettext (#5237) 5 years ago
README.md [doc] Simplify and reorganize readme (#5217) 5 years ago
datastorage.lua [build] Add support for Debian packages (#4434) 5 years ago
defaults.lua Give more control over CRe margins (#4945) 5 years ago
kodev [shell] Avoid hard-coded path (#5197) 5 years ago
reader.lua Give more control over CRe margins (#4945) 5 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

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 money 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