2
0
mirror of https://github.com/koreader/koreader synced 2024-10-31 21:20:20 +00:00
Go to file
2020-03-20 12:01:38 +01:00
.ci [CI] Add curly braces check (#5809) 2020-02-02 20:35:21 +01:00
.circleci [CI] Docker koreader/koappimage:0.1.7 for ragel (#5753) 2020-01-06 20:45:58 +01:00
.github Add Liberapay link (#5770) 2020-01-15 18:28:17 +01:00
base@7a5c9e1110 bump crengine: support font-variant, more FB2 metadata (#5980) 2020-03-19 13:19:46 +01:00
doc [doc] macOS build info tweaks (#5891) 2020-02-22 09:11:29 +01:00
frontend Add DJVU MIME type to OPDS browser (#5982) 2020-03-20 09:18:16 +01:00
l10n@2c0f08d14d [i18n] Bump translations submodule for v2020.03 release (#5927) 2020-03-07 20:17:18 +01:00
metadata@98fd6c8fe0 add metadata, to be used by fdroid 2020-01-02 01:29:28 +01:00
platform android: same version code for all archs (#5972) 2020-03-16 22:57:07 +01:00
plugins [fix] don't crash when enabling statistics on new book (#5971) 2020-03-20 12:01:38 +01:00
resources Update fonts & add Noto Sans Devanagari UI (#5803) 2020-01-31 17:25:13 +01:00
spec/unit continuous: do not limit visible area to page area (#5885) 2020-02-20 23:00:32 +01:00
test@86eeb0b43d
tools [fix] Add CanvasContext to wbuilder (#5287) 2019-08-31 14:13:34 +02:00
.busted
.codecov.yml
.editorconfig
.gitignore [chore] Add translations to submodule (#5506) 2019-10-19 15:18:50 +02:00
.gitmodules add metadata, to be used by fdroid 2020-01-02 01:29:28 +01:00
.luacheckrc Remove DSCROLL_MODE and DGLOBALGAMMA (#5754) 2020-01-07 20:16:59 +01:00
.luacov
.shellcheckrc [CI] Add curly braces check (#5809) 2020-02-02 20:35:21 +01:00
.travis.yml
COPYING
datastorage.lua android: unbreak KO on scoped storage devices 2019-12-12 21:17:03 +01:00
defaults.lua Remove DSCROLL_MODE and DGLOBALGAMMA (#5754) 2020-01-07 20:16:59 +01:00
kodev Get rid of the old PB TC (#5860) 2020-02-15 23:49:04 +01:00
Makefile [Kindle] Hide the status bar on current FW, too. (#5943) 2020-03-15 01:28:37 +01:00
reader.lua Warn if color rendering is enabled on a grayscale device. (#5871) 2020-02-18 02:24:48 +01:00
README.md Add Remarkable to README.md (#5839) 2020-02-12 08:13:11 +01: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 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 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.

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