diff options
author | Harry Jeffery <harry@exec64.co.uk> | 2019-08-20 19:26:19 +0100 |
---|---|---|
committer | Harry Jeffery <harry@exec64.co.uk> | 2019-08-20 19:26:19 +0100 |
commit | e06ca72f07eb746fadd2a66eea1c3d9fe6dda36d (patch) | |
tree | 374b8a68d85659c7f4598870573c4efb432f4e47 /PACKAGERS.md | |
parent | 96b6dc3aae7f2407860d15cc545f2397eee2a283 (diff) | |
download | imv-e06ca72f07eb746fadd2a66eea1c3d9fe6dda36d.tar.gz |
Update README
Diffstat (limited to 'PACKAGERS.md')
-rw-r--r-- | PACKAGERS.md | 19 |
1 files changed, 16 insertions, 3 deletions
diff --git a/PACKAGERS.md b/PACKAGERS.md index 3339174..aaa08b1 100644 --- a/PACKAGERS.md +++ b/PACKAGERS.md @@ -3,7 +3,20 @@ This document is a quick summary of all you need to know to package imv for your favourite operating system. -## 1. Select backends +## 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. + +Alternatively, you could provide separate packages for X11 and Wayland that +act as alternatives to each other. + +## 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 @@ -17,13 +30,13 @@ 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. -## 2. $ make && make install +## 3. $ make && make install 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. -## 3. Package +## 4. Package Package the resulting binary and man pages in your operating system's native package format. |