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
poire-z b9724f1e93 Text highlighting: extend to include punctuations
When selected text seems to be a "sentence segment"
(that is, when there are punctuations around start
AND end), extend the selection to include the relevant
punctuation.
Do this only when saving highlights and for translation
(but not when dict or wikipedia lookups, or search).
2 years ago
.ci [CI] Use Ubuntu 20.04 Docker image for CI tests (#9007) 2 years ago
.circleci [CI] Use Ubuntu 20.04 Docker image for CI tests (#9007) 2 years ago
.github [CI] Update macOS GitHub Action to macOS 11 (#8525) 2 years ago
base@7548930c38 bump crengine: text selection tweaks and helpers 2 years ago
doc [doc] Update busted version mentioned in docs (#9078) 2 years ago
frontend Text highlighting: extend to include punctuations 2 years ago
l10n@6751e03985 Update translations for 2022.05 (#9118) 2 years ago
metadata/en-US F-Droid description: tame expectations (#8178) 3 years ago
platform bump android-luajit-launcher 2 years ago
plugins Make luacheck >= 0.26 happy (#9174) 2 years ago
resources Keyboard: add Bengali Probhat layout (#8887) 2 years ago
spec/unit Make luacheck >= 0.26 happy (#9174) 2 years ago
test@86eeb0b43d various test/coverage optimization 8 years ago
tools keyboard: japanese: always put digits as the south gesture for latin (#8443) 3 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 Add macOS target 4 years ago
.gitmodules add basic metadata for F-Droid 3 years ago
.luacheckrc luacheckrc: allow busted's "match" global for spec/ (#8369) 3 years ago
.luacov [CI] Also run coverage on plugins (#3447) 7 years ago
.shellcheckrc [CI] Add curly braces check (#5809) 4 years ago
.travis.yml quickstart fix (#2804) 7 years ago
COPYING switch license to AGPLv3 10 years ago
Makefile Unbreak Kobo build (#8882) 2 years ago
README.md Readme: Tame down expectations (#8177) 3 years ago
datastorage.lua Fix koreader not using XDG_CONFIG_HOME on linux (#8507) 2 years ago
defaults.lua Raise DocumentCache hard cap to 512MB 3 years ago
kodev Bump android backend (#7813) 3 years ago
reader.lua Initial Kindle PW5 support (#8856) 2 years ago
setupkoenv.lua setupkoenv: ffi.load: search rocks 2 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 Weblate Status

DownloadUser guideWikiDeveloper 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), 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

  • fast: on some older devices, it has been measured to have less than half the page-turn delay as the built in reading software.

  • and much more: look up words with StarDict dictionaries / Wikipedia, add your own online OPDS catalogs and RSS feeds, over-the-air software updates, an FTP client, an SSH server, …

Please check the user guide and 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