From 12b6a50dbaa506d09fd459d8f290d7a7468e9715 Mon Sep 17 00:00:00 2001 From: Kunal Mehta Date: Mon, 2 Jan 2017 06:52:53 -0800 Subject: [PATCH] Add README with build instructions (closes #3, #6) --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 000000000..a12793bc6 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +libkiwix +======== + +libkiwix contains the common code base for all kiwix ports. + +You'll need the following dependencies to build libkiwix: + +* libicu-dev +* [libzim](http://www.openzim.org/wiki/Zimlib) +* libpugixml-dev - 1.8+, compiled with `-DBUILD_PKGCONFIG=1 -DBUILD_SHARED_LIBS=1` +* aria2c (usually via `aria2` package) +* [meson](http://mesonbuild.com/) +* pkg-config +* libxapian-dev + +To build: + +``` +$ cd kiwix-lib +$ mkdir -p build +$ cd build +$ meson .. +$ ninja +$ ninja install +``` + +Licensed as GPLv3 or later, see COPYING for more details.