koreader-mirror

mirror of https://github.com/koreader/koreader.git synced 2025-12-13 20:36:53 +01:00

Go to file

Frans de Jonge ac1fa5d677 [plugin] Wallabag: Make remove from history consistent with deletion (#6320 )

Finished is a specific status distinct from 100% read.

Also reorganize the menus slightly.

Closes <#6316>.

2020-06-28 11:34:22 +02:00

.ci

[CI] Add curly braces check (#5809 )

2020-02-02 20:35:21 +01:00

.circleci

[CI] Docker koreader/koappimage:0.1.7 for ragel (#5753 )

2020-01-06 20:45:58 +01:00

.github

Add FR template (#6296 )

2020-06-22 18:26:39 +02:00

base @ 849231bf51

bump crengine: add support for <ruby> elements

2020-06-25 14:51:32 +02:00

doc

[doc] Add some tips about GitHub PR refs (#6289 )

2020-06-24 12:49:34 +02:00

frontend

[UX] Add left to close to ConfigDialog for hasFewKeys (#6318 )

2020-06-27 09:11:05 +02:00

l10n @ c1c917ad0e

Update translations for 2020.06 release (#6271 )

2020-06-15 18:09:03 +02:00

metadata @ 98fd6c8fe0

add metadata, to be used by fdroid

2020-01-02 01:29:28 +01:00

platform

disable runtime behaviour changes on fdroid

2020-06-24 12:49:14 +02:00

plugins

[plugin] Wallabag: Make remove from history consistent with deletion (#6320 )

2020-06-28 11:34:22 +02:00

resources

Update bundled fonts (#6242 )

2020-06-08 16:36:06 +02:00

spec/unit

Tests: make sure files are deleted (#6323 )

2020-06-28 08:03:37 +02:00

test @ 86eeb0b43d

various test/coverage optimization

2016-08-15 00:32:40 +08:00

tools

[fix] Add CanvasContext to wbuilder (#5287 )

2019-08-31 14:13:34 +02: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

[feat] Allow message to be overlaid on other screensavers (#6238 )

2020-06-06 19:23:16 +02:00

.gitmodules

add metadata, to be used by fdroid

2020-01-02 01:29:28 +01:00

.luacheckrc

unified calibre plugin (#6177 )

2020-06-19 12:22:38 +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

switch license to AGPLv3

2014-03-23 16:53:05 +08:00

datastorage.lua

android: unbreak KO on scoped storage devices

2019-12-12 21:17:03 +01:00

defaults.lua

unified calibre plugin (#6177 )

2020-06-19 12:22:38 +02:00

kodev

Get rid of the old PB TC (#5860 )

2020-02-15 23:49:04 +01:00

Makefile

[Android] Add support for custom startup scripts (#6275 )

2020-06-19 21:23:47 +02:00

reader.lua

Warn if color rendering is enabled on a grayscale device. (#5871 )

2020-02-18 02:24:48 +01:00

README.md

Add Remarkable to README.md (#5839 )

2020-02-12 08:13:11 +01:00

setupkoenv.lua

A few minor fixes after #4847 (#4850 )

2019-03-29 20:12:09 +01:00

README.md

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

Download • 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), 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:

Android • Cervantes • Kindle • Kobo • Linux • Pocketbook • reMarkable

Development

Setting a build environment • Collaborating with Git • Building targets • Porting • Developer docs

Support

KOReader is developed and supported by volunteers all around the world. There are many ways you can help:

fix bugs and implement new features
translate the program into your language or improve an existing translation
document lesser-known features on the wiki
help others with your knowledge on the forum

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.

Also if you have and old Pocketbook device you don't want, we might find it useful to tinker a bit with that platform. Please contact us through the forum or GitHub.