2
0
mirror of https://github.com/koreader/koreader synced 2024-10-31 21:20:20 +00:00
Go to file
2021-03-29 20:32:38 +02:00
.ci CI: Update to Busted 2.0.0 2020-12-19 04:16:51 +01:00
.circleci [chore] (#6764) 2020-10-09 19:15:16 +02:00
.github Unbreak macOS build (#7313) 2021-02-18 23:46:29 +01:00
base@fd30a65587 Bump base 2021-03-27 20:49:29 +01:00
doc Add Lua 5.1 to sample Debubuntu apt-get command (#7421) 2021-03-27 10:41:01 +01:00
frontend Improve fit to … help text (#7462) 2021-03-29 20:32:38 +02:00
l10n@ea65427674 Update translations for 2021.03 (#7450) 2021-03-27 10:40:34 +01:00
metadata@98fd6c8fe0 add metadata, to be used by fdroid 2020-01-02 01:29:28 +01:00
platform Remarkable1 wifi (#7216) 2021-02-02 03:19:37 +01:00
plugins Standardize directory/folder to folder (#7410) 2021-03-28 13:35:56 +02:00
resources Rotation icons: make 'em dynamic. (#7440) 2021-03-29 05:12:22 +02:00
spec/unit Screensaver: Fix a fallback snafu (#7397) 2021-03-08 06:30:14 +01:00
test@86eeb0b43d various test/coverage optimization 2016-08-15 00:32:40 +08:00
tools Remove PNG icons, add koreader.svg 2020-12-19 14:49:18 +01:00
.busted Travis update 2015-08-24 16:40:52 +02:00
.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 metadata, to be used by fdroid 2020-01-02 01:29:28 +01:00
.luacheckrc Update UI layout code to use new SVG icons 2020-12-19 14:49:18 +01: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 switch license to AGPLv3 2014-03-23 16:53:05 +08:00
datastorage.lua [CI] Mac OS app (#6955) 2020-12-11 15:16:29 +01:00
defaults.lua Fix y origin of the configmenu extended tapzone (#7015) 2020-12-20 09:32:43 +01:00
kodev reader.lua: rework file/directory argument handling. (#7053) 2021-01-07 20:38:10 +01:00
Makefile Remove PNG icons, add koreader.svg 2020-12-19 14:49:18 +01:00
reader.lua LuaSettings: Add a method to initialize a setting properly (#7371) 2021-03-06 22:44:18 +01:00
README.md Remove sourceror.io (#6986) 2020-12-13 10:27:26 +01:00
setupkoenv.lua A few minor fixes after #4847 (#4850) 2019-03-29 20:12:09 +01: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

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