Archives/koreader
2
0
Fork 0
mirror of https://github.com/koreader/koreader synced 2024-10-31 21:20:20 +00:00
Code Issues Projects Releases Wiki Activity
7b6a3f3cb2
koreader/README.md

109 lines
7.0 KiB
Markdown
Raw Normal View History

README: add new logo and links from koreader.rocks homepage (#3881) References #3858 #2000
2018-04-15 18:35:02 +00:00
[![KOReader](https://raw.githubusercontent.com/koreader/koreader.github.io/master/koreader-logo.png)](https://koreader.rocks)
[doc] Simplify and reorganize readme (#5217) References #5213.
2019-08-20 15:01:28 +00:00
#### KOReader is a document viewer primarily aimed at e-ink readers.
UI Behavior tweaks (#3983) * Switch all initial highlights to "fast" update i.e., everything that does an invert Plus a few other things that refresh small UI elements onTap Re #3130 * Tweak refreshtype for a number of widgets: * Fix iconbutton dimen * Make touchmenu flash on close & initial menu popup. Full-screen on close. * Use flashing updates when opening/closing dictionary popup. Full-screen on close. * Switch FileManager to partial. It's mostly text, and we want flash promotion there. * Make configdialog & menu flash on exit * Make FLWidget flash on close * virtualkeyboard: flash on layout change & popup. * Potentially not that great workaround to ensure we actually see the highlights in the FM's chevrons * Flash when closing BookStatus Widget * Optimize away a quirk of the dual "fast" update in touchmenu * Promote updates to flashing slightly more agressively. * Document what each refreshtype actually does. With a few guidelines on their optimal usecases. * Switch remaining scheduleIn(0.0) to nextTick() * Tighter scheduling timers Shaving a hundred ms off UI callbacks... * Cache FFI C Library namespace * Ask MuPDF to convert pixmaps to BGR on Kobo Fix #3949 * Mention koxtoolchain in the README re #3972 * Kindle: Handle *all* fonts via EXT_FONT_DIR instead of bind mounts insanity * Make black flashes in UI elements user-configurable (All or nothing). * Jot down some random KOA2 sysfs path
2018-06-02 16:10:55 +00:00
[doc] Simplify and reorganize readme (#5217) References #5213.
2019-08-20 15:01:28 +00:00
[![AGPL Licence][badge-license]](COPYING)
[![Latest release][badge-release]][link-gh-releases]
[![Gitter][badge-gitter]][link-gitter]
[![Mobileread][badge-mobileread]][link-forum]
[![Build Status][badge-circleci]][link-circleci]
[![Coverage Status][badge-coverage]][link-coverage]
experimental port to Mac OSX Currently it can open cre-based docs and Djvu docs It still has some problems with PDF docs and the touch input.
2016-04-14 17:18:19 +00:00
[doc] Simplify and reorganize readme (#5217) References #5213.
2019-08-20 15:01:28 +00:00
[Download](https://github.com/koreader/koreader/releases) •
[Wiki](https://github.com/koreader/koreader/wiki) •
[Developer docs](http://koreader.rocks/doc/)
build: add luacheck for static analysis
2015-04-27 00:43:32 +00:00
[doc] Simplify and reorganize readme (#5217) References #5213.
2019-08-20 15:01:28 +00:00
## Main features
automatically adjust ev time for kobo touch
2016-05-24 05:38:08 +00:00
[doc] Simplify and reorganize readme (#5217) References #5213.
2019-08-20 15:01:28 +00:00
* **portable**: runs on embedded devices (Cervantes, Kindle, Kobo, PocketBook), Android and Linux computers. Developers can run a KOReader emulator in Linux and MacOS.
add make test in Makefile and README file
2014-03-25 14:26:36 +00:00
[doc] Simplify and reorganize readme (#5217) References #5213.
2019-08-20 15:01:28 +00:00
* **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.
update README
2013-03-24 19:13:03 +00:00
[doc] Simplify and reorganize readme (#5217) References #5213.
2019-08-20 15:01:28 +00:00
* **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.
support for building against custom koreader-base repo
2014-01-01 21:07:28 +00:00
[doc] Simplify and reorganize readme (#5217) References #5213.
2019-08-20 15:01:28 +00:00
* **integrated** with *calibre* (search metadata, receive ebooks wirelessly, browse library via OPDS), *Evernote* (export hightlights), *Wallabag*, *Wikipedia*, *Google Translate* and other content providers.
support for building against custom koreader-base repo
2014-01-01 21:07:28 +00:00
[doc] Simplify and reorganize readme (#5217) References #5213.
2019-08-20 15:01:28 +00:00
* **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.
README.md: add automake and improve clarity Most people will be looking for the emulator info first, so put it on top. Fixes #2595
2017-02-28 19:03:24 +00:00
[doc] Simplify and reorganize readme (#5217) References #5213.
2019-08-20 15:01:28 +00:00
* **extensible**: via plugins
README.md: add automake and improve clarity Most people will be looking for the emulator info first, so put it on top. Fixes #2595
2017-02-28 19:03:24 +00:00
[doc] Simplify and reorganize readme (#5217) References #5213.
2019-08-20 15:01:28 +00:00
* **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, …
README.md: add automake and improve clarity Most people will be looking for the emulator info first, so put it on top. Fixes #2595
2017-02-28 19:03:24 +00:00
[doc] Simplify and reorganize readme (#5217) References #5213.
2019-08-20 15:01:28 +00:00
Please check the [wiki][link-wiki] to discover more features and to help us document them.
README.md: add automake and improve clarity Most people will be looking for the emulator info first, so put it on top. Fixes #2595
2017-02-28 19:03:24 +00:00
[doc] Simplify and reorganize readme (#5217) References #5213.
2019-08-20 15:01:28 +00:00
## Screenshots
README.md: add automake and improve clarity Most people will be looking for the emulator info first, so put it on top. Fixes #2595
2017-02-28 19:03:24 +00:00
[doc] Simplify and reorganize readme (#5217) References #5213.
2019-08-20 15:01:28 +00:00
<a href="https://github.com/koreader/koreader-artwork/raw/master/koreader-menu.png"><img src="https://github.com/koreader/koreader-artwork/raw/master/koreader-menu-thumbnail.png" alt="" width="200px"></a>
<a href="https://github.com/koreader/koreader-artwork/raw/master/koreader-footnotes.png"><img src="https://github.com/koreader/koreader-artwork/raw/master/koreader-footnotes-thumbnail.png" alt="" width="200px"></a>
<a href="https://github.com/koreader/koreader-artwork/raw/master/koreader-dictionary.png"><img src="https://github.com/koreader/koreader-artwork/raw/master/koreader-dictionary-thumbnail.png" alt="" width="200px"></a>
README.md: add automake and improve clarity Most people will be looking for the emulator info first, so put it on top. Fixes #2595
2017-02-28 19:03:24 +00:00
[doc] Simplify and reorganize readme (#5217) References #5213.
2019-08-20 15:01:28 +00:00
## Installation
README.md: add automake and improve clarity Most people will be looking for the emulator info first, so put it on top. Fixes #2595
2017-02-28 19:03:24 +00:00
[doc] Simplify and reorganize readme (#5217) References #5213.
2019-08-20 15:01:28 +00:00
Please follow the model specific steps for your device:
README.md: add automake and improve clarity Most people will be looking for the emulator info first, so put it on top. Fixes #2595
2017-02-28 19:03:24 +00:00
[doc] Simplify and reorganize readme (#5217) References #5213.
2019-08-20 15:01:28 +00:00
[Android](https://github.com/koreader/koreader/wiki/Installation-on-Android-devices) •
[Cervantes](https://github.com/koreader/koreader/wiki/Installation-on-BQ-devices) •
[Kindle](https://github.com/koreader/koreader/wiki/Installation-on-Kindle-devices) •
[Kobo](https://github.com/koreader/koreader/wiki/Installation-on-Kobo-devices) •
[Linux](https://github.com/koreader/koreader/wiki/Installation-on-desktop-linux) •
[Pocketbook](https://github.com/koreader/koreader/wiki/Installation-on-PocketBook-devices)
add emulation bootstrap target in makefile & update README
2013-03-24 16:18:53 +00:00
now make po should be issued manually
2014-06-05 12:54:36 +00:00
[doc] Simplify and reorganize readme (#5217) References #5213.
2019-08-20 15:01:28 +00:00
## Development
Added some instruction about the translation of variables Simplified building prerequisites
2014-11-29 20:46:33 +00:00
[doc] Simplify and reorganize readme (#5217) References #5213.
2019-08-20 15:01:28 +00:00
[Setting a build environment](doc/Building.md) •
[Collaborating with Git](doc/Collaborating_with_Git.md) •
[Building targets](doc/Building_targets.md) •
[Porting](doc/Porting.md) •
[Developer docs](http://koreader.rocks/doc/)
Added some instruction about the translation of variables Simplified building prerequisites
2014-11-29 20:46:33 +00:00
[doc] Simplify and reorganize readme (#5217) References #5213.
2019-08-20 15:01:28 +00:00
## Support
Added some instruction about the translation of variables Simplified building prerequisites
2014-11-29 20:46:33 +00:00
[doc] Simplify and reorganize readme (#5217) References #5213.
2019-08-20 15:01:28 +00:00
KOReader is developed and supported by volunteers all around the world. There are many ways you can help:
update README
2013-03-24 19:13:03 +00:00
[doc] Simplify and reorganize readme (#5217) References #5213.
2019-08-20 15:01:28 +00:00
- [fix bugs][link-issues-bugs] and [implement new features][link-issues-features]
- [translate the program into your language][link-translations-transifex] or improve an existing translation
Fix a spelling mistake in README.md (#5483)
2019-10-12 11:37:21 +00:00
- document lesser-known features on the [wiki][link-wiki]
[doc] Simplify and reorganize readme (#5217) References #5213.
2019-08-20 15:01:28 +00:00
- help others with your knowledge on the [forum][link-forum]
readme update from Lucas Malor @ mobileread see http://www.mobileread.com/forums/showpost.php?p=2488740&postcount=979
2013-04-20 22:28:42 +00:00
Minor stylistic correction suggested by spammer (#5505)
2019-10-18 19:50:45 +00:00
At this moment we don't support any form of monetary donation, but you can create a [bounty][link-bountysource] for the specific bug or feature request you want and motivate others to do the work.
update README on emulation
2013-03-26 23:21:30 +00:00
[doc] Simplify and reorganize readme (#5217) References #5213.
2019-08-20 15:01:28 +00:00
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.
add back emulator screen setting hint
2013-04-20 22:31:24 +00:00
[doc] Simplify and reorganize readme (#5217) References #5213.
2019-08-20 15:01:28 +00:00
## Contributors
Hall-of-fame to recognize contributors on README (#4168)
2018-08-18 06:42:14 +00:00
[doc] Simplify and reorganize readme (#5217) References #5213.
2019-08-20 15:01:28 +00:00
[![Last commit][badge-last-commit]][link-gh-commits]
[![Commit activity][badge-commit-activity]][link-gh-insights]
Hall-of-fame to recognize contributors on README (#4168)
2018-08-18 06:42:14 +00:00
[![0](https://sourcerer.io/fame/Frenzie/koreader/koreader/images/0)](https://sourcerer.io/fame/Frenzie/koreader/koreader/links/0)
[![1](https://sourcerer.io/fame/Frenzie/koreader/koreader/images/1)](https://sourcerer.io/fame/Frenzie/koreader/koreader/links/1)
[![2](https://sourcerer.io/fame/Frenzie/koreader/koreader/images/2)](https://sourcerer.io/fame/Frenzie/koreader/koreader/links/2)
[![3](https://sourcerer.io/fame/Frenzie/koreader/koreader/images/3)](https://sourcerer.io/fame/Frenzie/koreader/koreader/links/3)
[![4](https://sourcerer.io/fame/Frenzie/koreader/koreader/images/4)](https://sourcerer.io/fame/Frenzie/koreader/koreader/links/4)
[![5](https://sourcerer.io/fame/Frenzie/koreader/koreader/images/5)](https://sourcerer.io/fame/Frenzie/koreader/koreader/links/5)
[![6](https://sourcerer.io/fame/Frenzie/koreader/koreader/images/6)](https://sourcerer.io/fame/Frenzie/koreader/koreader/links/6)
[![7](https://sourcerer.io/fame/Frenzie/koreader/koreader/images/7)](https://sourcerer.io/fame/Frenzie/koreader/koreader/links/7)
[doc] Simplify and reorganize readme (#5217) References #5213.
2019-08-20 15:01:28 +00:00
[badge-bountysource]:https://img.shields.io/bountysource/team/koreader/activity?color=red
[badge-circleci]:https://circleci.com/gh/koreader/koreader.svg?style=shield
[badge-coverage]:https://codecov.io/gh/koreader/koreader/branch/master/graph/badge.svg
[badge-commit-activity]:https://img.shields.io/github/commit-activity/m/koreader/koreader
[badge-gitter]:https://img.shields.io/gitter/room/koreader/koreader?color=red
[badge-last-commit]:https://img.shields.io/github/last-commit/koreader/koreader?color=orange
[badge-license]:https://img.shields.io/github/license/koreader/koreader
[badge-release]:https://img.shields.io/github/release/koreader/koreader.svg
[badge-mobileread]:https://img.shields.io/badge/forum-on_mobileread-lightgrey
[link-bountysource]:https://www.bountysource.com/teams/koreader
[link-circleci]:https://circleci.com/gh/koreader/koreader
[link-coverage]:https://codecov.io/gh/koreader/koreader
[link-forum]:http://www.mobileread.com/forums/forumdisplay.php?f=276
[link-gh-commits]:https://github.com/koreader/koreader/commits/master
[link-gh-insights]:https://github.com/koreader/koreader/pulse
[link-gh-releases]:https://github.com/koreader/koreader/releases
[link-gitter]:https://gitter.im/koreader/koreader
[link-issues-bugs]:https://github.com/koreader/koreader/issues?q=is%3Aopen+is%3Aissue+label%3Abug
[link-issues-features]:https://github.com/koreader/koreader/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement
[link-translations-transifex]:https://www.transifex.com/projects/p/koreader/
[link-wiki]:https://github.com/koreader/koreader/wiki
Reference in New Issue Copy Permalink