2
0
mirror of https://github.com/koreader/koreader synced 2024-10-31 21:20:20 +00:00
Go to file
2019-08-22 18:01:04 +02:00
.ci [fix, CI] Push developer docs once again (#5243) 2019-08-22 18:01:04 +02:00
.circleci [CI] Switch to custom xgettext build to extract multiline strings (#5242) 2019-08-22 17:11:47 +02:00
.github ISSUE_TEMPLATE: add request to share crash.log (#3296) 2017-10-04 17:22:08 +02:00
base@07688a3ce4 bump crengine: CSS parsing: cleanup and optimisations (#5239) 2019-08-22 09:05:25 +02:00
doc [fix] Update LDoc config (#5231) 2019-08-20 17:41:09 +02:00
frontend [CI] Switch to custom xgettext build to extract multiline strings (#5242) 2019-08-22 17:11:47 +02:00
l10n i10n/README: small stylistic changes 2017-11-02 20:43:22 +01:00
platform [Kindle] Update Kindle support devices list (#5235) 2019-08-22 15:36:56 +02:00
plugins [CI] Switch to custom xgettext build to extract multiline strings (#5242) 2019-08-22 17:11:47 +02:00
resources Bump koreader-fonts (#5210) 2019-08-14 17:13:31 +02:00
spec/unit More footer options, default to use icons as prefixes (#5203) 2019-08-16 23:22:58 +02:00
test@86eeb0b43d various test/coverage optimization 2016-08-15 00:32:40 +08:00
tools Various blitting related cleanups (#4789) 2019-03-14 20:58:45 +01:00
.busted Travis update 2015-08-24 16:40:52 +02:00
.codecov.yml [CI] Add .codecov.yml (#4695) 2019-03-01 17:29:04 +01:00
.editorconfig experimental port to Mac OSX 2016-04-22 20:13:44 +08:00
.gitignore Ignore all top-level files and dirs kindle-* and *.sdr 2019-04-16 22:42:05 -07:00
.gitmodules [fix] Switch ubuntu-touch-sdl-template to our own mirror (#5157) 2019-07-31 20:56:51 +02:00
.luacheckrc [statistics] Remove conversion message on new installations (#5120) 2019-07-17 15:15:21 +02:00
.luacov [CI] Also run coverage on plugins (#3447) 2017-10-29 21:09:13 +01:00
.travis.yml quickstart fix (#2804) 2017-04-24 08:27:29 +02:00
COPYING switch license to AGPLv3 2014-03-23 16:53:05 +08:00
datastorage.lua [build] Add support for Debian packages (#4434) 2019-01-03 18:21:35 +01:00
defaults.lua Give more control over CRe margins (#4945) 2019-05-01 02:09:01 +02:00
kodev [shell] Avoid hard-coded path (#5197) 2019-08-11 21:30:35 +02:00
Makefile [i18n] Switch make pot to xgettext (#5237) 2019-08-21 22:18:14 +02:00
reader.lua Give more control over CRe margins (#4945) 2019-05-01 02:09:01 +02:00
README.md [doc] Simplify and reorganize readme (#5217) 2019-08-20 17:01:28 +02:00
setupkoenv.lua A few minor fixes after #4847 (#4850) 2019-03-29 20:12:09 +01:00

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