699ee3efc1
I've played a bit with #6275, to make the iterator available for non-power users too. this PR automate user data migration (which happens once per update). If the folder `koreader/scripts.afterupdate` contains a file `migrate` then files will be copied to internal dir preserving their relative path. Thus user data **needs** to have the same hierarchy as internal directories. Shell scripts will be find and run if the folder `koreader/scripts.afterupdate` exists and has no `migrate file`. In the case of `koreader/scripts.always` there's no migration available, just shell scripts. Digging a bit seems not possible to create new directories on app internal storage (it just crashes on the emulator since API25). So very fancy extensions are not supported, but it is ok to override files and create new files if dir already exists. Tested with: ```find scripts.afterupdate/ scripts.afterupdate/ scripts.afterupdate/data scripts.afterupdate/data/hyph scripts.afterupdate/data/hyph/Roman.pattern scripts.afterupdate/data/example.css scripts.afterupdate/migrate ``` Results: ``` 06-20 16:16:33.590 3584 3597 I KOReader: after-update: running migration 06-20 16:16:33.596 3584 3597 I KOReader: command cp /storage/emulated/0/koreader/scripts.afterupdate/data/hyph/Roman.pattern /data/user/0/org.koreader.launcher/files/data/hyph/Roman.pattern returned 0 06-20 16:16:33.600 3584 3597 I KOReader: command cp /storage/emulated/0/koreader/scripts.afterupdate/data/example.css /data/user/0/org.koreader.launcher/files/data/example.css returned 0 06-20 16:16:33.604 3584 3597 I KOReader: command rm /data/user/0/org.koreader.launcher/files/afterupdate.marker returned 0 ``` |
4 years ago | |
|---|---|---|
| .ci | 4 years ago | |
| .circleci | 4 years ago | |
| .github | 4 years ago | |
| base@2210b65f5a | 4 years ago | |
| doc | 4 years ago | |
| frontend | 4 years ago | |
| l10n@c1c917ad0e | 4 years ago | |
| metadata@98fd6c8fe0 | 4 years ago | |
| platform | 4 years ago | |
| plugins | 4 years ago | |
| resources | 4 years ago | |
| spec/unit | 4 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 | 4 years ago | |
| .gitmodules | 4 years ago | |
| .luacheckrc | 4 years ago | |
| .luacov | 7 years ago | |
| .shellcheckrc | 4 years ago | |
| .travis.yml | 7 years ago | |
| COPYING | 10 years ago | |
| Makefile | 4 years ago | |
| README.md | 4 years ago | |
| datastorage.lua | 4 years ago | |
| defaults.lua | 4 years ago | |
| kodev | 4 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, 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.
Contributors
