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

Slight improvements of the README.md

This commit is contained in:
Kelson 2019-08-27 16:30:20 +02:00
parent 56a08f49b2
commit bbb346b685
1 changed files with 10 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -1,8 +1,9 @@
Kiwix library Kiwix library
============= =============
The Kiwix library provides the Kiwix software core. It contains the The Kiwix library provides the [Kiwix](https://kiwix.org) software
code shared by all Kiwix ports (Windows, Linux, OSX, Android, ...). suite core. It contains the code shared by all Kiwix ports (Windows,
Linux, OSX, Android, ...).
[![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)
[![Build Status](https://travis-ci.org/kiwix/kiwix-lib.svg?branch=master)](https://travis-ci.org/kiwix/kiwix-lib) [![Build Status](https://travis-ci.org/kiwix/kiwix-lib.svg?branch=master)](https://travis-ci.org/kiwix/kiwix-lib)
@ -57,9 +58,9 @@ The Kiwix library builds using [Meson](https://mesonbuild.com/) version
compilation tools. compilation tools.
Install first the few common compilation tools: Install first the few common compilation tools:
* Meson * [Meson](https://mesonbuild.com/)
* Ninja * [Ninja](https://ninja-build.org/)
* Pkg-config * [pkg-config](https://www.freedesktop.org/wiki/Software/pkg-config/)
These tools should be packaged if you use a cutting edge operating These tools should be packaged if you use a cutting edge operating
system. If not, have a look to the [Troubleshooting](#Troubleshooting) system. If not, have a look to the [Troubleshooting](#Troubleshooting)
@ -70,7 +71,6 @@ Compilation
Once all dependencies are installed, you can compile the Kiwix library Once all dependencies are installed, you can compile the Kiwix library
with: with:
```bash ```bash
meson . build meson . build
ninja -C build ninja -C build
@ -88,32 +88,29 @@ Installation
If you want to install the Kiwix library and the headers you just have If you want to install the Kiwix library 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
``` ```
You might need to run the command as root (or using `sudo`), depending You might need to run the command as root (or using `sudo`), depending
where you want to install the libraries. After the installation where you want to install the libraries. After the installation
succeeded, you may need to run `ldconfig` (as root). succeeded, you may need to run `ldconfig` (as `root`).
Uninstallation Uninstallation
------------ ------------
If you want to uninstall the Kiwix library: If you want to uninstall the Kiwix library:
```bash ```bash
ninja -C build uninstall ninja -C build uninstall
``` ```
Like for the installation, you might need to run the command as root Like for the installation, you might need to run the command as `root`
(or using `sudo`). (or using `sudo`).
Troubleshooting Troubleshooting
--------------- ---------------
If you need to install Meson "manually": If you need to install Meson "manually":
```bash ```bash
virtualenv -p python3 ./ # Create virtualenv virtualenv -p python3 ./ # Create virtualenv
source bin/activate # Activate the virtualenv source bin/activate # Activate the virtualenv
@ -122,7 +119,6 @@ hash -r # Refresh bash paths
``` ```
If you need to install Ninja "manually": If you need to install Ninja "manually":
```bash ```bash
git clone git://github.com/ninja-build/ninja.git git clone git://github.com/ninja-build/ninja.git
cd ninja cd ninja
@ -142,4 +138,5 @@ repository.
License License
------- -------
GPLv3 or later, see COPYING for more details. [GPLv3](https://www.gnu.org/licenses/gpl-3.0) or later, see
[COPYING](COPYING) for more details.