smallsolar/libkiwix
1
0
Fork 0
mirror of https://github.com/kiwix/libkiwix.git synced 2025-06-26 10:11:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.

Browse Source 
Also add a COMPILE_ubuntu-16.04.md to let people compile on ubuntu 16.04.
This commit is contained in:
Matthieu Gautier
2017-01-23 15:16:15 +01:00
parent 317b13b56b
commit ed800e4f00
2 changed files with 130 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -3,16 +3,14 @@ libkiwix
libkiwix contains the common code base for all kiwix ports.
Build kiwix-tools
-----------------
Build kiwix-lib
---------------
Most of the compilation steps (including download and
compilation of dependencies and other tools (kiwix-tools)) are handle
by [kiwix-build](https://github.com/kiwix/kiwix-build) script.
If you don't have any special need, we recommand you to use kiwix-build
If you don't have any special need, we recommend you to use kiwix-build
instead of doing all the steps yourself.
Dependencies:
@ -22,29 +20,15 @@ You'll need the following dependencies to build libkiwix:
* icu
* libzim
* pugixml
* aria2c
* ctpp2
* xapian (optional)
* xapian (optional) (>=1.4)
* meson build system (>=0.34)(and so, ninja, pkg-config, ...)
On debian architecture, you can install the following deb packages:
* libicu-dev
* libxapian-dev
* libctpp2-dev
* aria2c
You will need to install yourself:
* [libzim](http://www.openzim.org/wiki/Zimlib)
* libpugixml - 1.8+, compiled with `-DBUILD_PKGCONFIG=1 -DBUILD_SHARED_LIBS=1`
As we use meson to build kiwix-tools, you will need the common meson tools:
* [meson](http://mesonbuild.com/) >= 0.34
* ninja
* pkg-config
To build:
Once all dependencies are installed, you can compile kiwix-lib with:
```
$ cd kiwix-lib
$ mkdir build
$ meson . build
$ cd build
$ ninja
@ -55,4 +39,15 @@ By default, it will compile dynamic linked libraries.
If you want statically linked libraries, you can add `--default-library=static`
option to the meson command.
(You may need to set PKG_CONFIG_PATH before running meson depending of where
and how you've install dependencies)
(Depending of you system, `ninja` may be called `ninja-build`)
Howto build kiwix-lib on Ubuntu 16.04 (LTS)
-------------------------------------------
If you want to compile yourself kiwix-lib see the specific readme to
[compile kiwix-lib on Ubuntu 16.04](COMPILE_ubuntu-16.04.md).
Licensed as GPLv3 or later, see COPYING for more details.