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
Nick ef22e85469 UI Changes (#5508)
* Changed File Browser text

KOReader looks nicer than KOReader File Browser,

* Remove the "page x of x" if only one page

Removes it from the bottom of the file browser

* Remove the "page x of x" if only one page

Removes it from the top menu, if there is only one page, why show page 1 of 1

* Renamed ~ to Home

Since the file browser can be considered "Home"

* Added 12 hour time option

Also tweaked the charging icon,  looks nicer than +, tweaked seperator between time and battery, - instead of @
5 years ago
.ci [chore] Convert a couple more todos (#5267) 5 years ago
.circleci [CI] Switch to custom xgettext build to extract multiline strings (#5242) 5 years ago
.github ISSUE_TEMPLATE: add request to share crash.log (#3296) 7 years ago
base@d9a685c681 bump crengine: adds DOCX and FB3 support (#5498) 5 years ago
doc [doc] Add internal documentation references (#5285) 5 years ago
frontend UI Changes (#5508) 5 years ago
l10n@1afc501b11 [chore] Add translations to submodule (#5506) 5 years ago
platform android: fix ko paths when primary storage is a SD card 5 years ago
plugins UI Changes (#5508) 5 years ago
resources Bump koreader-fonts (#5210) 5 years ago
spec/unit Minor state handling tweaks when the footer is disabled/invisible (#5494) 5 years ago
test@86eeb0b43d various test/coverage optimization 8 years ago
tools [fix] Add CanvasContext to wbuilder (#5287) 5 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 [chore] Add translations to submodule (#5506) 5 years ago
.gitmodules [chore] Add translations to submodule (#5506) 5 years ago
.luacheckrc [UX] Option to show progress bar at the bottom of the screen (#5442) 5 years ago
.luacov [CI] Also run coverage on plugins (#3447) 7 years ago
.travis.yml quickstart fix (#2804) 7 years ago
COPYING switch license to AGPLv3 10 years ago
Makefile [fix] kodev: Allow nightly build to succeed (#5507) 5 years ago
README.md Minor stylistic correction suggested by spammer (#5505) 5 years ago
datastorage.lua [build] Add support for Debian packages (#4434) 5 years ago
defaults.lua remove unused ANDROID_FONT_DIR and update defaults.spec 5 years ago
kodev [fix] kodev: Allow nightly build to succeed (#5507) 5 years ago
reader.lua Fix debug logging in the framebuffer module 5 years ago
setupkoenv.lua A few minor fixes after #4847 (#4850) 5 years 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

DownloadWikiDeveloper docs

Main features

  • portable: runs on embedded devices (Cervantes, Kindle, Kobo, PocketBook), 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:

AndroidCervantesKindleKoboLinuxPocketbook

Development

Setting 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:

At this moment we don't support any form of monetary donation, but you can create a bounty for the specific bug or feature request you want and motivate others to do the work.

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.

Contributors

Last commit Commit activity

0 1 2 3 4 5 6 7