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

Libkiwix, not Kiwix library

This commit is contained in:
Emmanuel Engelhart 2021-05-30 15:42:28 +02:00
parent f4b8d0c303
commit 4f7175ad59
1 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
README.md
View File

@ -1,8 +1,8 @@
Kiwix library Libkiwix
============= ========
The Kiwix library provides the [Kiwix](https://kiwix.org) software The Libkiwix provides the [Kiwix](https://kiwix.org) software suite
suite core. It contains the code shared by all Kiwix ports (Windows, core. It contains the code shared by all Kiwix ports (Windows,
GNU/Linux, macOS, Android, iOS, ...). GNU/Linux, macOS, Android, iOS, ...).
[![Download](https://api.bintray.com/packages/kiwix/kiwix/kiwixlib/images/download.svg)](https://bintray.com/kiwix/kiwix/kiwixlib/_latestVersion) [![Download](https://api.bintray.com/packages/kiwix/kiwix/kiwixlib/images/download.svg)](https://bintray.com/kiwix/kiwix/kiwixlib/_latestVersion)
@ -18,23 +18,23 @@ Disclaimer
This document assumes you have a little knowledge about software This document assumes you have a little knowledge about software
compilation. If you experience difficulties with the dependencies or compilation. If you experience difficulties with the dependencies or
with the Kiwix libary compilation itself, we recommend to have a look with the Libkiwix compilation itself, we recommend to have a look to
to [kiwix-build](https://github.com/kiwix/kiwix-build). [kiwix-build](https://github.com/kiwix/kiwix-build).
Preamble Preamble
-------- --------
Although the Kiwix library can be (cross-)compiled on/for many Although the Libkiwix can be (cross-)compiled on/for many sytems, the
sytems, the following documentation explains how to do it on POSIX following documentation explains how to do it on POSIX ones. It is
ones. It is primarly thought for GNU/Linux systems and has been tested primarly thought for GNU/Linux systems and has been tested on recent
on recent releases of Ubuntu and Fedora. releases of Ubuntu and Fedora.
Dependencies Dependencies
------------ ------------
The Kiwix library relies on many third parts software libraries. They The Libkiwix relies on many third party software libraries. They are
are prerequisites to the Kiwix library compilation. Following prerequisites to the Libkiwix compilation. Following libraries need to
libraries need to be available: be available:
* [ICU](https://site.icu-project.org/) (package `libicu-dev` on Ubuntu) * [ICU](https://site.icu-project.org/) (package `libicu-dev` on Ubuntu)
* [ZIM](https://openzim.org/) (package `libzim-dev` on Ubuntu) * [ZIM](https://openzim.org/) (package `libzim-dev` on Ubuntu)
@ -42,9 +42,9 @@ libraries need to be available:
* [Mustache](https://github.com/kainjow/Mustache) (Just copy the * [Mustache](https://github.com/kainjow/Mustache) (Just copy the
header `mustache.hpp` somewhere it can be found by the compiler and/or header `mustache.hpp` somewhere it can be found by the compiler and/or
set CPPFLAGS with correct `-I` option). Use Mustache version 4.1 or above. set CPPFLAGS with correct `-I` option). Use Mustache version 4.1 or above.
* [libcurl](https://curl.se/libcurl) (`libcurl4-gnutls-dev`, `libcurl4-nss-dev` or `libcurl4-openssl-dev` on Ubuntu) * [Libcurl](https://curl.se/libcurl) (`libcurl4-gnutls-dev`, `libcurl4-nss-dev` or `libcurl4-openssl-dev` on Ubuntu)
* [microhttpd](https://www.gnu.org/software/libmicrohttpd) (package `libmicrohttpd-dev` on Ubuntu) * [Microhttpd](https://www.gnu.org/software/libmicrohttpd) (package `libmicrohttpd-dev` on Ubuntu)
* [zlib](https://zlib.net/) (package `zlib1g-dev` on Ubuntu) * [Zlib](https://zlib.net/) (package `zlib1g-dev` on Ubuntu)
The following dependency needs to be available at runtime: The following dependency needs to be available at runtime:
* [Aria2](https://aria2.github.io/) (package `aria2` on Ubuntu) * [Aria2](https://aria2.github.io/) (package `aria2` on Ubuntu)
@ -61,7 +61,7 @@ If you want to install these dependencies locally, then use the
Environment Environment
------------- -------------
The Kiwix library builds using [Meson](https://mesonbuild.com/) version The Libkiwix builds using [Meson](https://mesonbuild.com/) version
0.45 or higher. Meson relies itself on Ninja, pkg-config and few other 0.45 or higher. Meson relies itself on Ninja, pkg-config and few other
compilation tools. compilation tools.
@ -77,7 +77,7 @@ section.
Compilation Compilation
----------- -----------
Once all dependencies are installed, you can compile the Kiwix library Once all dependencies are installed, you can compile the Libkiwix
with: with:
```bash ```bash
meson . build meson . build
@ -85,7 +85,7 @@ ninja -C build
``` ```
By default, it will compile dynamic linked libraries. All binary files By default, it will compile dynamic linked libraries. All binary files
will be created in the "build" directory created automatically by will be created in the `build` directory created automatically by
Meson. If you want statically linked libraries, you can add Meson. If you want statically linked libraries, you can add
`--default-library=static` option to the Meson command. `--default-library=static` option to the Meson command.
@ -103,7 +103,7 @@ meson test
Installation Installation
------------ ------------
If you want to install the Kiwix library and the headers you just have If you want to install the Libkiwix and the headers you just have
compiled on your system, here we go: compiled on your system, here we go:
```bash ```bash
ninja -C build install ninja -C build install
@ -147,8 +147,8 @@ cd ..
``` ```
If you compile manually Libmicrohttpd, you might need to compile it If you compile manually Libmicrohttpd, you might need to compile it
without GNU TLS, a bug here will empeach further compilation of Kiwix without GNU TLS, a bug here will empeach further compilation
tools otherwise. otherwise.
If the compilation still fails, you might need to get a more recent If the compilation still fails, you might need to get a more recent
version of a dependency than the one packaged by your Linux version of a dependency than the one packaged by your Linux