4.5 KiB
Building targets
KOReader is available for multiple platforms. Here are instructions to build installable packages for all these platforms.
These instructions are intended for a Linux OS. MacOS and Windows users are suggested to develop in a Linux VM.
Prerequisites
This instructions asume that you have a development environment ready to run KOReader. If not then please install common prerequisites first.
A toolchain for your target.
Each target has its own architecture and you'll need to setup a proper cross-compile toolchain. Your GCC should be at least version 4.9.
for Android
A compatible version of the Android NDK and SDK will be downloaded automatically by ./kodev release android if no NDK or SDK is provided in environment variables. For that purpose you can use:
NDK=/ndk/location SDK=/sdk/location ./kodev release android
If you want to use your own installed tools please make sure that you have the NDKr15c and the SDK for Android 9 (API level 28) already installed.
for embedded linux devices
Cross compile toolchains are available for Ubuntu users through these commands:
Ubuntu Touch
sudo apt-get install gcc-arm-linux-gnueabihf g++-arm-linux-gnueabihf
NOTE 1: The packages pkg-config-arm-linux-gnueabihf and pkg-config-arm-linux-gnueabi may
block you from building. Remove them if you get the following ld error
/usr/lib/gcc-cross/arm-linux-gnueabihf/4.8/../../../../arm-linux-gnueabihf/bin/ld: cannot find -lglib-2.0
e-Ink devices (e.g., Kindle, Kobo, Cervantes, reMarkable, PocketBook)
NOTE: While, for some targets (specifically, Cervantes, Kindle & Kobo), we make some effort to support Linaro/Ubuntu TCs,
they do not exactly target the proper devices. While your build may go fine, this will probably lead to runtime failure.
As time goes by, and/or the more bleeding-edge your distro is, the greater the risk for mismatch gets.
Which means, that, unless you are very sure you know what you're doing, you'll want to use the exact same TCs we do, ones that target their respective platforms properly.
We have a distribution-agnostic solution to make that mostly painless: koxtoolchain!
This will allow you to build the exact same TCs used to build the nightlies, thanks to the magic of crosstool-ng. These are also included precompiled in the Docker images for the respective targets.
Additional packages
Some platforms will require additional packages:
for Android
Building for Android requires openjdk-8-jdk and p7zip-full.
For both Ubuntu and Debian, install the packages:
sudo apt-get install openjdk-8-jdk p7zip-full
for Debian
Building a debian package requires the dpkg-deb tool. It should be already installed if you're on a Debian/Ubuntu based distribution.
for Ubuntu Touch
Building for Ubuntu Touch requires the click package management tool.
Ubuntu users can install it with:
sudo apt-get install click
NOTE: The Ubuntu Touch build won't start anymore, and none of the currently active developers have any physical devices. Please visit #4960 if you want to help.
The Ubuntu Touch builds are therefore no longer published under releases on GitHub, but they are still available from the nightly build server.
Building
You can check out our nightlybuild script to see how to build a package from scratch.
Android
./kodev release android
Android (x86)
ANDROID_ARCH=x86 ./kodev release android
Desktop Linux
Emulator
See Building.
AppImage (x86_64)
./kodev release appimage
Debian (x86_64)
./kodev release debian
Debian (armel)
./kodev release debian-armel
Debian (armhf)
./kodev release debian-armhf
Desktop macOS
./kodev release macos
e-Ink devices
Cervantes
./kodev release cervantes
Kindle
./kodev release kindle
Kobo
./kodev release kobo
Pocketbook
./kodev release pocketbook
reMarkable
./kodev release remarkable
Embedded Linux devices
Ubuntu Touch
./kodev release ubuntu-touch
Porting to a new target.
See Porting.md