You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
NiLuJe 90c38e2d0d ReadHistory: nil guard a Document instance access 8 months ago
.ci CI: Update to Busted 2.0.0 1 year ago
.circleci [chore] (#6764) 1 year ago
.github Cache: Fix a whole lot of things. 9 months ago
base@2c264e54f4 Bump base (#7675) 8 months ago
doc Add Lua 5.1 to sample Debubuntu apt-get command (#7421) 10 months ago
frontend ReadHistory: nil guard a Document instance access 8 months ago
l10n@5eed1a41d2 Update translations for 2021.05 release (#7707) 8 months ago
metadata@98fd6c8fe0 add metadata, to be used by fdroid 2 years ago
platform android: avoid downloading the APK again if there's one download in progress + fix signature error (#7657) 8 months ago
plugins TextEditor: Disable on non-Touch devices 8 months ago
resources SortWidget: More tweaks 9 months ago
spec/unit Unbreak ReaderFooter test 8 months ago
test@86eeb0b43d various test/coverage optimization 6 years ago
tools Remove PNG icons, add koreader.svg 1 year ago
.busted Travis update 6 years ago
.codecov.yml [CI] Add .codecov.yml (#4695) 3 years ago
.editorconfig experimental port to Mac OSX 6 years ago
.gitignore Add macOS target 2 years ago
.gitmodules add metadata, to be used by fdroid 2 years ago
.luacheckrc Update UI layout code to use new SVG icons 1 year ago
.luacov [CI] Also run coverage on plugins (#3447) 4 years ago
.shellcheckrc [CI] Add curly braces check (#5809) 2 years ago
.travis.yml quickstart fix (#2804) 5 years ago
COPYING switch license to AGPLv3 8 years ago
Makefile android: keep bundled version in a dedicated text file (#7649) 8 months ago
README.md Remove sourceror.io (#6986) 1 year ago
datastorage.lua [CI] Mac OS app (#6955) 1 year ago
defaults.lua Cache: Fix a whole lot of things. 9 months ago
kodev reader.lua: rework file/directory argument handling. (#7053) 1 year ago
reader.lua FileManager/ReaderUI: Clarify the current instance accessor (#7658) 8 months ago
setupkoenv.lua The great Input/GestureDetector/TimeVal spring cleanup (a.k.a., a saner main loop) (#7415) 10 months 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, 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 up 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.

Contributors

Last commit Commit activity