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
NiLuJe 5146358605 NetworkManager: Allow backends to report connection failures early
As early as turnOnWifi.
Implement it on hasWifiManager platforms, preventing useless
connectivity checks to run when they're obviously never going to work
because you're out of range of your AP.

Also implemented a flag to notify the backend if the connection attempt
was interactive or not.
Right now, interactive is extremely restricted, it basically means the
menu checkmark, or a gesture.
The intent being that for stuff like the beforeWifiAction framework, we
don't want the backend to spawn extra UI.
Specifically, for hasWifiManager platforms, we no longer spawn the AP
scan list on failure unless the caller was interactive.

TL;DR: beforeWifiAction is now much less obnoxious when you're obviously
not able to connect.
9 months ago
.ci [CI] Don't hide docs generation log (#9204) 2 years ago
.circleci [CI] Also use Ubuntu 20.04 Docker image for docs (#9209) 2 years ago
.github mac: github actions macos-13 (#10404) 1 year ago
base@bab6f040e7 Bump base 10 months ago
doc Deal with table.pack corner-cases properly (#10350) 1 year ago
frontend NetworkManager: Allow backends to report connection failures early 9 months ago
l10n@6fe9e0ea24 Update translations for v2023.06.1 (#10665) 11 months ago
metadata update metadata & translations 2 years ago
platform Kobo: Initial Elipsa 2E support (#10719) 10 months ago
plugins Profiles: fix New profile with current pdf document settings (#10778) 10 months ago
resources Bookmark flipping mode fix (#10196) 1 year ago
spec/unit Revert "Test: Fiw readerhighlight test" 9 months ago
test@86eeb0b43d various test/coverage optimization 8 years ago
tools android: speed up development cycle 11 months 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 Cleanup various varargs shenanigans (#9624) 2 years ago
.luacov [CI] Also run coverage on plugins (#3447) 7 years ago
.luarc.json Add a config file for the Lua LSP (#10611) 11 months 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 android: update to use NDK 23c 11 months ago
README.md Readme: update list of supported formats (#10004) 1 year ago
datastorage.lua DataStorage: fix typo and actually create $HOME/.config if it doesn't exist yet (#10390) 1 year ago
defaults.lua Cleanup: Track color constant name change (#9716) 2 years ago
kodev Never export LD_LIBRARY_PATH 10 months ago
reader.lua Startup: Move Device ctor/dtor shenanigans to the actual Device 9 months ago
setupkoenv.lua Env: Actually use the full ffi.load signature in our overload 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

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, RTF, HTML, CHM, TXT). Scanned PDF/DjVu documents can also be reflowed with the built-in K2pdfopt library. ZIP files are also supported for some formats.

  • 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