koreader

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 0382e0d4c2 OTM: Handle syntax errors at both stages when migrating defaults.persistent.lua We were pcall'ing the parsing, but not the execution... The funky Lua syntax quirks means that it is possible to pass the former but not the latter ;). Fix #9700, de-facto regression since #9546		2 years 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	GH: Mention that toggling verbose debug logging requires a restart.	2 years ago
base@5957a6b805	GestureDetector: Only show the final adjustGesCoordinate log if the gesture actually was adjusted.	2 years ago
doc	Cleanup various varargs shenanigans (#9624 )	2 years ago
frontend	OTM: Handle syntax errors at both stages when migrating	2 years ago
l10n@734e27b3f4	Update translations for 2022.10 (#9670 )	2 years ago
metadata	update metadata & translations	2 years ago
platform	Support Android AArch64 (#9645 )	2 years ago
plugins	AutoSuspend: Update the standby help message.	2 years ago
resources	Bump koreader-fonts to unbreak FreeFonts (#9508 )	2 years ago
spec/unit	InputContainer: Fall cleanup ;).	2 years ago
test@86eeb0b43d	various test/coverage optimization	8 years ago
tools	InputContainer: Fall cleanup ;).	2 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	Cleanup various varargs shenanigans (#9624 )	2 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	Support Android AArch64 (#9645 )	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 )	3 years ago
defaults.lua	Misc: Get rid of the legacy defaults.lua globals (#9546 )	2 years ago
kodev	Support Android AArch64 (#9645 )	2 years ago
reader.lua	Cleanup: Use Lua's native setvbuf wrapper instead of reinventing the wheel (#9636 )	2 years ago
setupkoenv.lua	setupkoenv: ffi.load: search rocks	2 years ago

README.md

KOReader is a document viewer primarily aimed at e-ink readers.

Download • User guide • Wiki • Developer 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, …