This is a document viewer application, originally created for usage on the
KOReader is a document viewer application, originally created for usage on the
Kindle e-ink reader. It currently supports Kindle 5 (Touch), Kindle Paperwhite
Kindle e-ink reader. It currently supports Kindle 5 (Touch), Kindle Paperwhite
and Kobo devices. Kindles need to be jailbroken in order to install the
, Kobo and Android devices.
application. Also, a kind of external launcher is needed.
KOReader started as the KindlePDFViewer application, but it supports much more
KOReader started as the KindlePDFViewer application, but it supports much more
formats than PDF now. Among them are DJVU, FB2, EPUB, TXT, CBZ, HTML.
formats than PDF now. Among them are DJVU, FB2, EPUB, TXT, CBZ, HTML.
KOReader is a frontend written in Lua and uses the API presented by the
KOReader is a frontend written in Lua and uses the API presented by the
KOReader-base framework. KOReader implements a GUI and is currently targeted
koreader-base framework. KOReader implements a GUI and is currently targeted
at Touch-based devices - for the classic user interface for button-driven
at touch-based devices - for the classic user interface for button-driven
e-ink devices (like the Kindle 2, Kindle DX, Kindle 3, Kindle 4) see the
e-ink devices (like the Kindle 2, Kindle DX, Kindle 3, Kindle 4) see the
KindlePDFviewer legacy project or - especially for the Kindle 4 - have a look
KindlePDFviewer legacy project or - especially for the Kindle 4 - have a look
at its fork Librerator.
at its fork Librerator.
@ -24,8 +23,8 @@ more about this project.
Prerequisites
Prerequisites
========
========
Instructions about how to get and compile the source are intended for a \*nix
Instructions about how to get and compile the source are intended for a linux
OS. Windows users are suggested to develop in a [Linux VM](http://www.howtogeek.com/howto/11287/how-to-run-ubuntu-in-windows-7-with-vmware-player/) or use Wubi.
OS. Windows users are suggested to develop in a [Linux VM][linux-vm] or use Wubi.
To get and compile the source you must have `patch`, `wget`, `unzip`, `git`, `autoconf`,
To get and compile the source you must have `patch`, `wget`, `unzip`, `git`, `autoconf`,
`subversion` and `cmake` installed. Version of autoconf need to be greater than 2.64.
`subversion` and `cmake` installed. Version of autoconf need to be greater than 2.64.
@ -35,7 +34,7 @@ Ubuntu users may need to run:
sudo apt-get install build-essential libtool
sudo apt-get install build-essential libtool
```
```
Cross toolchains are available to Ubuntu users through these commands:
Cross compile toolchains are available for Ubuntu users through these commands: