|
|
|
@ -44,10 +44,10 @@ Highlights for developers
|
|
|
|
|
* light-weight widget toolkit for small memory footprint
|
|
|
|
|
* extensible with plugin system
|
|
|
|
|
* interfaced backends for documents parsing and rendering
|
|
|
|
|
* high quality document backend libraries like MuPDF, DjvuLibre and Crengine
|
|
|
|
|
* high quality document backend libraries like MuPDF, DjvuLibre and CREngine
|
|
|
|
|
* interacting with frontend via LuaJIT FFI for best performence
|
|
|
|
|
* in active development
|
|
|
|
|
* contributed by 28 and more developers around the world
|
|
|
|
|
* contributed by developers around the world
|
|
|
|
|
* continuous integration with Travis CI
|
|
|
|
|
* with unit tests and code coverage test
|
|
|
|
|
* automatic release of nightly builds
|
|
|
|
@ -82,18 +82,15 @@ sudo apt-get install gcc-arm-linux-gnueabihf g++-arm-linux-gnueabihf
|
|
|
|
|
sudo apt-get install gcc-mingw-w64-i686 g++-mingw-w64-i686
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
A recent version of Android SDK/NDK and `ant` are needed in order to build Koreader for Android
|
|
|
|
|
devices.
|
|
|
|
|
A recent version of Android SDK/NDK and `ant` are needed in order to build
|
|
|
|
|
Koreader for Android devices.
|
|
|
|
|
```
|
|
|
|
|
sudo apt-get install ant
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
You might also need SDL library packages if you want to compile and run
|
|
|
|
|
Koreader on your Linux PC. Fedora users can install `SDL` and `SDL-devel`.
|
|
|
|
|
Ubuntu users probably need to run:
|
|
|
|
|
```
|
|
|
|
|
sudo apt-get install libsdl1.2-dev
|
|
|
|
|
```
|
|
|
|
|
koreader on Linux PC. Fedora users can install `SDL` and `SDL-devel` package.
|
|
|
|
|
Ubuntu users probably need to install `libsdl1.2-dev` package:
|
|
|
|
|
|
|
|
|
|
Getting the source
|
|
|
|
|
========
|
|
|
|
@ -120,9 +117,9 @@ To build installable package for Kobo:
|
|
|
|
|
make TARGET=kobo clean koboupdate
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
To run, you must call the script reader.lua. Run it without arguments to see
|
|
|
|
|
usage notes. Note that the script and the koreader-base binary currently must
|
|
|
|
|
be in the same directory.
|
|
|
|
|
To run, you must call the script `reader.lua`. Run it without arguments to see
|
|
|
|
|
usage notes. Note that the script and the `luajit` binary must be in the same
|
|
|
|
|
directory.
|
|
|
|
|
|
|
|
|
|
You may checkout our [nightlybuild script][nb-script] to see how to build a
|
|
|
|
|
package from scratch.
|
|
|
|
@ -144,7 +141,7 @@ Then, build installable package for Android:
|
|
|
|
|
make TARGET=android clean androidupdate
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
For emulating Koreader on Linux and Windows
|
|
|
|
|
For emulating KOReader on Linux and Windows
|
|
|
|
|
-------------
|
|
|
|
|
|
|
|
|
|
To build an emulator on current Linux machine just run:
|
|
|
|
@ -163,7 +160,7 @@ To run koreader on your developing machine
|
|
|
|
|
cd koreader-$(MACHINE)/koreader && ./reader.lua -d ../../test
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
To run unit tests in Koreader just issue:
|
|
|
|
|
To run unit tests in KOReader:
|
|
|
|
|
```
|
|
|
|
|
make test
|
|
|
|
|
```
|
|
|
|
@ -190,8 +187,8 @@ modifications with kroeader frontend. NOTE: only support relative path for now.
|
|
|
|
|
Translation
|
|
|
|
|
========
|
|
|
|
|
|
|
|
|
|
Please refer to [l10n's README][l10n-readme] to grab the latest translations from
|
|
|
|
|
[the Koreader project on Transifex][koreader-transifex] with this command:
|
|
|
|
|
Please refer to [l10n's README][l10n-readme] to grab the latest translations
|
|
|
|
|
from [the Koreader project on Transifex][koreader-transifex] with this command:
|
|
|
|
|
```
|
|
|
|
|
make po
|
|
|
|
|
```
|
|
|
|
|