aboutsummaryrefslogtreecommitdiff
path: root/PACKAGERS.md
diff options
context:
space:
mode:
authorEric Engestrom <eric.engestrom@intel.com>2019-12-24 10:33:54 +0000
committerHarry Jeffery <harry@exec64.co.uk>2020-02-08 00:29:25 +0000
commit04ef9440fb079736020d796142de18008da3ba62 (patch)
tree014e98965acaa95cd7ebf4569e5d052f4ef33833 /PACKAGERS.md
parent2dd0c1469e2d87c5263fb513c331b82617ca2e12 (diff)
downloadimv-04ef9440fb079736020d796142de18008da3ba62.tar.gz
drop the old Makefile and update the docs
Diffstat (limited to 'PACKAGERS.md')
-rw-r--r--PACKAGERS.md23
1 files changed, 14 insertions, 9 deletions
diff --git a/PACKAGERS.md b/PACKAGERS.md
index aaa08b1..11c8fc0 100644
--- a/PACKAGERS.md
+++ b/PACKAGERS.md
@@ -3,20 +3,23 @@
This document is a quick summary of all you need to know to package imv for
your favourite operating system.
-## 1. Select window systems to support
+## Configuring `imv`
+
+### 1. Select window systems to support
Your options here are Wayland or X11, or both. By default both are included,
with a separate binary for each being built. `/usr/bin/imv` will be a script
that checks for a Wayland compositor before running the appropriate binary.
If you only care about one of these, you can specify to build only one of these
-in [config.mk](config.mk), in which case only that binary shall be packaged
-without the need for a launcher script to select between the two.
+by passing `-D windows=wayland` to `meson`, in which case only that
+binary shall be packaged without the need for a launcher script to
+select between the two.
Alternatively, you could provide separate packages for X11 and Wayland that
act as alternatives to each other.
-## 2. Select backends to include
+### 2. Select backends to include
imv supports multiple "backends" in a plugin style architecture. Each backend
provides support for different image formats using different underlying
@@ -26,17 +29,19 @@ formats you need support for, and your licensing requirements.
imv is published under the MIT license, but its backends may have different
licensing requirements.
-You can configure the backends to use in [config.mk](config.mk). Sensible
-defaults are pre-configured to provide maximum coverage with the least overlap
-and fewest dependencies.
+By default, the libraries available are detected and support for them is
+automatically enabled, but you can enable or disable specific ones by
+passing `-D freeimage=enabled` or `-D libtiff=disabled`.
+You can also make sure all the backends are enabled by passing
+`-D auto_features=enabled`.
-## 3. $ make && make install
+## Building `imv`
Once your backends have been configured and you've confirmed the library
each backend uses is installed, you can simply follow the Installation section
of the [README](README.md) to build imv.
-## 4. Package
+## Packaging `imv`
Package the resulting binary and man pages in your operating system's native
package format.