7952fa2c09
Small tweaks all around to handle UI mirroring: - swap existing symbols like arrows, or use alternative ones - rotate some images, like chevrons and dogear icons - flip some left and right swipe handling - flip some geometry arithmetic like tap on left or right side of page or dict window - use new ProgressWidget:getPercentageFromPosition() instead of geometry arithmetic - BD.wrap() some concatenated string bits, like in reader and menu footers - flip inverse_reading_order when UI is mirrored More specific tweaks: - ReaderGesture: reset some specific gestures when UI direction has changed (tap on top/bottom left/right corners, for bookmarks and FileManager "Plus menu"). - ReaderRolling: show markers on the correct side of page, in single or dual page mode. - KoptOptions: swap left and right icons in Alignment toggle - CheckMark: proper rendering in all 4 mirroring/rtl combinations. - VirtualKeyboard: forbid any mirroring - Move util.getMenuText into Menu.lua |
4 years ago | |
|---|---|---|
| .ci | 5 years ago | |
| .circleci | 5 years ago | |
| .github | 5 years ago | |
| base@10cfb8379d | 4 years ago | |
| doc | 5 years ago | |
| frontend | 4 years ago | |
| l10n@c848073a4c | 5 years ago | |
| platform | 4 years ago | |
| plugins | 4 years ago | |
| resources | 5 years ago | |
| spec/unit | 5 years ago | |
| test@86eeb0b43d | 8 years ago | |
| tools | 5 years ago | |
| .busted | 9 years ago | |
| .codecov.yml | 5 years ago | |
| .editorconfig | 8 years ago | |
| .gitignore | 5 years ago | |
| .gitmodules | 5 years ago | |
| .luacheckrc | 5 years ago | |
| .luacov | 7 years ago | |
| .travis.yml | 7 years ago | |
| COPYING | 10 years ago | |
| Makefile | 4 years ago | |
| README.md | 5 years ago | |
| datastorage.lua | 5 years ago | |
| defaults.lua | 5 years ago | |
| kodev | 5 years ago | |
| reader.lua | 4 years ago | |
| setupkoenv.lua | 5 years ago | |
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), 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
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
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
