Update documentation

Since the build system has changed after modularization. Also,
point out that the project now supports Kobo devices too.
pull/250/head
Paulo Matias 11 years ago
parent 25a2920716
commit b16bad974e

@ -1,10 +1,10 @@
KOReader KOReader
======== ========
This is a document viewer application, created for usage on the Kindle e-ink reader. This is a document viewer application, originally created for usage on the
It currently supports Kindle 5 (Touch) and Kindle Paperwhite. The devices need Kindle e-ink reader. It currently supports Kindle 5 (Touch), Kindle Paperwhite
to be jailbroken in order to install the application. Also, a kind of external and Kobo devices. Kindles need to be jailbroken in order to install the
launcher is needed. 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.
@ -22,7 +22,7 @@ The application is licensed under the GPLv3 (see COPYING file).
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 \*nix
OS. Windows users are suggested to develop in a Linux VM or use OS. Windows users are suggested to develop in a Linux VM or use
andLinux, Wubi. andLinux, Wubi.
@ -30,7 +30,7 @@ To get and compile the source you must have `patch`, `wget`, `unzip`, `git`,
`svn` and `cmake` installed. `svn` and `cmake` installed.
You might also need SDL library packages if you want to compile and run the PC You might also need SDL library packages if you want to compile and run the PC
emulator. Fedora user can install `SDL` and `SDL-devel`. Ubuntu users can emulator. Fedora users can install `SDL` and `SDL-devel`. Ubuntu users can
install `libsdl1.2-dev`. install `libsdl1.2-dev`.
@ -52,12 +52,17 @@ For real eink devices
If you already done an emulator build, you must do: If you already done an emulator build, you must do:
``` ```
make clean cleanthirdparty make clean
``` ```
To build: To build for the Kindle:
``` ```
make all customupdate make customupdate
```
To build for the Kobo:
```
make TARGET_DEVICE=KOBO koboupdate
``` ```
To run, you must call the script reader.lua. Run it without arguments to see To run, you must call the script reader.lua. Run it without arguments to see
@ -72,18 +77,18 @@ For emulating
If you already done a real device build, you must do: If you already done a real device build, you must do:
``` ```
make clean cleanthirdparty make clean
``` ```
To build To build
``` ```
EMULATE_READER=1 make all bootstrapemu EMULATE_READER=1 make
``` ```
To run: To run:
``` ```
cd emu && ./reader.lua -d ./ cd koreader-*/koreader && ./reader.lua -d ./
``` ```
You can also specify size of emulator's screen via environment variables. You can also specify size of emulator's screen via environment variables.

Loading…
Cancel
Save