2
0
mirror of https://github.com/koreader/koreader synced 2024-10-31 21:20:20 +00:00
Go to file
2020-07-19 14:43:21 +02: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 FR template (#6296) 2020-06-22 18:26:39 +02:00
base@11ed619bb3 Bump base & luajit-launcher for new LuaJIT (#6389) 2020-07-17 23:39:30 +02:00
doc ReaderGesture: cleanup (#6292) 2020-07-12 14:47:49 -04:00
frontend Fix footer update on UpdatePos event (#6392) 2020-07-19 06:56:39 +02:00
l10n@0c2a7b5675 Update translations for 2020.07 release (#6395) 2020-07-19 14:43:21 +02:00
metadata@98fd6c8fe0 add metadata, to be used by fdroid 2020-01-02 01:29:28 +01:00
platform Bump base & luajit-launcher for new LuaJIT (#6389) 2020-07-17 23:39:30 +02:00
plugins Perception expander: disable margin increase when set to 0 (#6377) 2020-07-15 20:31:40 -04:00
resources Add macOS target 2020-07-11 01:29:49 +02:00
spec/unit Tame a few tests that relied on pairs being somewhat deterministic (#6371) 2020-07-14 18:25:26 +02:00
test@86eeb0b43d various test/coverage optimization 2016-08-15 00:32:40 +08:00
tools [fix] Add CanvasContext to wbuilder (#5287) 2019-08-31 14:13:34 +02: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 Add macOS target 2020-07-11 01:29:49 +02:00
.gitmodules add metadata, to be used by fdroid 2020-01-02 01:29:28 +01:00
.luacheckrc unified calibre plugin (#6177) 2020-06-19 12:22:38 +02:00
.luacov [CI] Also run coverage on plugins (#3447) 2017-10-29 21:09:13 +01:00
.shellcheckrc [CI] Add curly braces check (#5809) 2020-02-02 20:35:21 +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 android: unbreak KO on scoped storage devices 2019-12-12 21:17:03 +01:00
defaults.lua unified calibre plugin (#6177) 2020-06-19 12:22:38 +02:00
kodev Add macOS target 2020-07-11 01:29:49 +02:00
Makefile Add macOS target 2020-07-11 01:29:49 +02:00
reader.lua [fix] Allow default FM rotation on init when Keep FM rotation is disabled (#6348) 2020-07-05 17:34:44 +02: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