Improved README
This commit is contained in:
parent
f93dd11bfe
commit
283c0a8e9d
44
README.md
44
README.md
|
@ -1,20 +1,21 @@
|
||||||
Build status: [](https://travis-ci.com/kiwix/kiwix-build)
|
# Kiwix Build
|
||||||
|
|
||||||
Kiwix is an offline reader for web content. It's especially thought to
|
Kiwix Build provides advanced tools to (cross-)compile easily
|
||||||
make Wikipedia available offline. This is done by reading the content
|
[Kiwix](https://kiwix.org) & [openZIM](https://openzim.org) softwares
|
||||||
of the project stored in a file format ZIM, a high compressed open
|
and libraries and deploy them. They have been tested on
|
||||||
format with additional meta-data.
|
[Fedora](https://getfedora.org) 23+ & [Ubuntu](https://ubuntu.com)
|
||||||
|
16.10+.
|
||||||
|
|
||||||
This repository contains advanced tools to (cross-)compile easily
|
[](https://travis-ci.com/kiwix/kiwix-build)
|
||||||
Kiwix softwares and library and deploy them. They have been tested on
|
|
||||||
Fedora 23 and Ubuntu 16.10.
|
|
||||||
|
|
||||||
# Prerequesites
|
Prerequesites
|
||||||
|
-------------
|
||||||
|
|
||||||
You will need a recent version of `meson` (0.34) and `ninja` (1.6) If
|
You will need a recent version of [Meson](https://mesonbuild.com/) (>=
|
||||||
your distribution provides a recent enough versions for them, just
|
0.34) and [Ninja](https://ninja-build.org) (>= 1.6) If your
|
||||||
install them with your package manager. Continue to read the
|
distribution provides a recent enough versions for them, just install
|
||||||
instructions otherwise.
|
them with your package manager. Continue to read the instructions
|
||||||
|
otherwise.
|
||||||
|
|
||||||
Before anything else you need to install Python3 related tools. On Debian
|
Before anything else you need to install Python3 related tools. On Debian
|
||||||
based systems:
|
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
|
unzip ninja-linux.zip ninja -d $HOME/bin
|
||||||
```
|
```
|
||||||
|
|
||||||
# Compilation
|
Compilation
|
||||||
|
-----------
|
||||||
|
|
||||||
The compilation is handled by the `kiwix-build` command. It will compile
|
The compilation is handled by the `kiwix-build` command. It will compile
|
||||||
everything. If you are using a supported platform (Redhat or Debian
|
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
|
kiwix-build --help
|
||||||
```
|
```
|
||||||
|
|
||||||
## Target
|
#### Target
|
||||||
|
|
||||||
You may want to compile a specific target so you will have to specify it on the
|
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` .
|
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
|
If no target platform is specified, a default one will be infered from
|
||||||
the specified target:
|
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
|
kiwix-build --target-platform win32_dyn
|
||||||
```
|
```
|
||||||
|
|
||||||
## Android
|
Android
|
||||||
|
-------
|
||||||
|
|
||||||
`kiwix-android` (https://github.com/kiwix/kiwix-android) depends of
|
`kiwix-android` (https://github.com/kiwix/kiwix-android) depends of
|
||||||
the `kiwix-lib` project.
|
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`.
|
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
|
When building for ios, we may want to compile a "fat library", a library
|
||||||
for several architectures.
|
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
|
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:
|
Kiwix-build.py will create several directories:
|
||||||
- `ARCHIVES`: All the downloaded archives go there.
|
- `ARCHIVES`: All the downloaded archives go there.
|
||||||
|
|
Loading…
Reference in New Issue