2
0
mirror of https://github.com/koreader/koreader synced 2024-11-04 12:00:25 +00:00
Go to file
Frans de Jonge 0f52499d37
Dispatcher: add unused singular to action plurals (#9734)
Tools and humans alike are confused by leaving it empty. It should be inoffensive to resolve the problem this by having an unused singular. Doing anything else would make it so we couldn't have the correct plurals in Slovak, among others.

Follow-up to https://github.com/koreader/koreader/pull/9726
2022-11-03 08:46:16 +01:00
.ci [CI] Don't hide docs generation log (#9204) 2022-06-12 13:37:07 +02:00
.circleci [CI] Also use Ubuntu 20.04 Docker image for docs (#9209) 2022-06-13 18:39:23 +02:00
.github GH: Mention that toggling verbose debug logging requires a restart. 2022-10-29 22:55:20 +02:00
base@f68861b68a Bump base 2022-11-02 03:48:39 +01:00
doc Cleanup various varargs shenanigans (#9624) 2022-10-12 19:59:48 +02:00
frontend Dispatcher: add unused singular to action plurals (#9734) 2022-11-03 08:46:16 +01:00
l10n@734e27b3f4 Update translations for 2022.10 (#9670) 2022-10-23 09:26:04 +02:00
metadata update metadata & translations 2022-10-23 10:26:20 +02:00
platform Support Android AArch64 (#9645) 2022-10-25 01:54:18 +02:00
plugins AutoWarmth: add message on user change of night mode (#9715) 2022-11-03 06:32:47 +01:00
resources Bump koreader-fonts to unbreak FreeFonts (#9508) 2022-09-11 19:08:35 +02:00
spec/unit [UIManager] Reverse order of _task_queue (#9706) 2022-11-02 20:08:15 +01:00
test@86eeb0b43d various test/coverage optimization 2016-08-15 00:32:40 +08:00
tools InputContainer: Fall cleanup ;). 2022-10-29 22:55:20 +02:00
.busted
.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 basic metadata for F-Droid 2021-06-17 21:54:03 +02:00
.luacheckrc Cleanup various varargs shenanigans (#9624) 2022-10-12 19:59:48 +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
datastorage.lua Fix koreader not using XDG_CONFIG_HOME on linux (#8507) 2021-12-05 21:16:22 +01:00
defaults.lua Cleanup: Track color constant name change (#9716) 2022-10-30 22:34:48 +01:00
kodev Support Android AArch64 (#9645) 2022-10-25 01:54:18 +02:00
Makefile Support Android AArch64 (#9645) 2022-10-25 01:54:18 +02:00
reader.lua Cleanup: Use Lua's native setvbuf wrapper instead of reinventing the wheel (#9636) 2022-10-14 18:44:36 +02:00
README.md Readme: Tame down expectations (#8177) 2021-09-04 11:54:30 +02:00
setupkoenv.lua setupkoenv: ffi.load: search rocks 2022-03-08 10:36:00 -05: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

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