summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorMatthias Vogelgesang <matthias.vogelgesang@kit.edu>2018-07-05 11:13:43 +0200
committerMatthias Vogelgesang <matthias.vogelgesang@kit.edu>2018-07-05 15:03:15 +0200
commit59b20e35463d57cd26c7c8986c2d2f498e1363f5 (patch)
treee761d9669392d1347209122cf14185673ad0ece2 /docs
parent9ac9a036fd08298afb29084a8c22b495385add2d (diff)
downloadufo-filters-59b20e35463d57cd26c7c8986c2d2f498e1363f5.tar.gz
ufo-filters-59b20e35463d57cd26c7c8986c2d2f498e1363f5.tar.bz2
ufo-filters-59b20e35463d57cd26c7c8986c2d2f498e1363f5.tar.xz
ufo-filters-59b20e35463d57cd26c7c8986c2d2f498e1363f5.zip
docs: add meson instructions
Diffstat (limited to 'docs')
-rw-r--r--docs/install.rst38
1 files changed, 32 insertions, 6 deletions
diff --git a/docs/install.rst b/docs/install.rst
index f83f4f1..ae6b44b 100644
--- a/docs/install.rst
+++ b/docs/install.rst
@@ -2,25 +2,51 @@
Installation
============
+
Prior to building the filter suite you have to install the base library ufo-core
as well as all task-specific dependencies (e.g. *libtiff* for :gobj:class:`read`
-and :gobj:class:`write`). Once installed you can check out the source with::
+and :gobj:class:`write`). Once ufo-core is installed you can check out the
+source with::
+
+ $ git clone https://github.com/ufo-kit/ufo-filters
+
- $ git clone https://github.com/ufo-kit/ufo-filters
+Building with CMake
+-------------------
Configure the build with::
- $ cd <source-path>
- $ cmake .
+ $ cd <source-path>
+ $ cmake .
Installation paths can be customized by passing ``configure`` equivalents like
so::
- $ cmake . -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_INSTALL_LIBDIR=/usr/lib64
+ $ cmake . -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_INSTALL_LIBDIR=/usr/lib64
Now build and install the filters with::
- $ make && make install
+ $ make && make install
Depending on the installation location, the second step requires administration
rights.
+
+
+Building with meson
+-------------------
+
+Configure the build with ``meson`` by changing into the root source directory
+and type ::
+
+ $ meson build
+
+You can change the location of GNU installation directories during this step or
+later with the ``meson configure`` tool ::
+
+ $ meson build --prefix=/usr
+ $ cd build && meson configure -Dprefix=/usr/local
+
+Build, test and install everything with ::
+
+ $ cd build
+ $ ninja && ninja test && ninja install