smallsolar
/
kiwix-build
mirror of https://github.com/kiwix/kiwix-build.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improved README

This commit is contained in:
Kelson 2019-12-14 14:38:57 +01:00
parent f93dd11bfe
commit 283c0a8e9d
1 changed files with 24 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
README.md
View File

@ -1,20 +1,21 @@
Build status: [![Build Status](https://travis-ci.com/kiwix/kiwix-build.svg?branch=master)](https://travis-ci.com/kiwix/kiwix-build)
# Kiwix Build
Kiwix is an offline reader for web content. It's especially thought to
make Wikipedia available offline. This is done by reading the content
of the project stored in a file format ZIM, a high compressed open
format with additional meta-data.
Kiwix Build provides advanced tools to (cross-)compile easily
[Kiwix](https://kiwix.org) & [openZIM](https://openzim.org) softwares
and libraries and deploy them. They have been tested on
[Fedora](https://getfedora.org) 23+ & [Ubuntu](https://ubuntu.com)
16.10+.
This repository contains advanced tools to (cross-)compile easily
Kiwix softwares and library and deploy them. They have been tested on
Fedora 23 and Ubuntu 16.10.
[![Build Status](https://travis-ci.com/kiwix/kiwix-build.svg?branch=master)](https://travis-ci.com/kiwix/kiwix-build)
# Prerequesites
Prerequesites
-------------
You will need a recent version of `meson` (0.34) and `ninja` (1.6) If
your distribution provides a recent enough versions for them, just
install them with your package manager. Continue to read the
instructions otherwise.
You will need a recent version of [Meson](https://mesonbuild.com/) (>=
0.34) and [Ninja](https://ninja-build.org) (>= 1.6) If your
distribution provides a recent enough versions for them, just install
them with your package manager. Continue to read the instructions
otherwise.
Before anything else you need to install Python3 related tools. On Debian
based systems:
@ -44,7 +45,8 @@ wget https://github.com/ninja-build/ninja/releases/download/v1.8.2/ninja-linux.z
unzip ninja-linux.zip ninja -d $HOME/bin
```
# Compilation
Compilation
-----------
The compilation is handled by the `kiwix-build` command. It will compile
everything. If you are using a supported platform (Redhat or Debian
@ -54,7 +56,7 @@ based) it will install missing packages using `sudo`. You can get
kiwix-build --help
```
## Target
#### Target
You may want to compile a specific target so you will have to specify it on the
@ -67,7 +69,7 @@ kiwix-build zim-tools # will build zim-tools and its dependencies
By default, `kiwix-build` will build `kiwix-tools` .
## Target platform
#### Target platform
If no target platform is specified, a default one will be infered from
the specified target:
@ -95,7 +97,8 @@ So, if you want to compile `kiwix-tools` for win32 using static linkage:
kiwix-build --target-platform win32_dyn
```
## Android
Android
-------
`kiwix-android` (https://github.com/kiwix/kiwix-android) depends of
the `kiwix-lib` project.
@ -129,7 +132,8 @@ $ kiwix-build kiwix-lib-app --android-arch arm --android-arch arm64 # aan with a
To build `kiwix-android` itself, you should see the documentation of `kiwix-android`.
## IOS
iOS
---
When building for ios, we may want to compile a "fat library", a library
for several architectures.
@ -147,8 +151,8 @@ kiwix-build --target-platform iOS_multi kiwix-lib # all architetures
kiwix-build --target-platform iOS_multi --ios-arch arm --ios-arch arm64 # arm and arm64 arch only
```
# Outputs
Outputs
-------
Kiwix-build.py will create several directories:
- `ARCHIVES`: All the downloaded archives go there.