From 350f0d2d2eaff5f0d57b09857102e2df1e96d733 Mon Sep 17 00:00:00 2001
From: cbdev <cb@cbcdn.com>
Date: Thu, 7 Nov 2019 18:44:19 +0100
Subject: Makefile install target and packaging instructions (Fixes #28)

---
 README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 130945a..c31f16c 100644
--- a/README.md
+++ b/README.md
@@ -156,6 +156,16 @@ be used to build a subset of the backends as well as the core.
 
 For Linux and OSX, just running `make` in the source directory should do the trick.
 
+The build process accepts the following parameters, either from the environment or
+as arguments to the `make` invocation:
+
+| Target	| Parameter		| Default value			| Description			|
+|---------------|-----------------------|-------------------------------|-------------------------------|
+| build targets	| `DEFAULT_CFG`		| `monster.cfg`			| Default configuration file	|
+| build targets	| `PLUGINS`		| Linux/OSX: `./backends/`, Windows: `backends\` | Backend plugin library path	|
+| `install`	| `DESTDIR`		| empty				| Destination directory for packaging builds	|
+| `install`	| `PREFIX`		| `/usr`			| Install prefix for binaries	|
+
 Some backends have been marked as optional as they require rather large additional software to be installed,
 for example the `ola` backend. To create a build including these, run `make full`.
 
@@ -163,6 +173,19 @@ To build for Windows, you still need to compile on a Linux machine.
 Install the crosscompiler package listed above and run `make windows`.
 This will build `midimonster.exe` as well as a set of backends as DLL files.
 
+For system-wide install or packaging builds, the following steps are recommended:
+
+```
+export PREFIX=/usr
+export PLUGINS=$PREFIX/lib/midimonster
+export DEFAULT_CFG=/etc/midimonster.cfg
+make
+make install
+```
+
+Depending on your configuration of `DESTDIR`, the `make install` step may require root privileges to
+install the binaries to the appropriate destinations.
+
 ## Development
 
 The architecture is split into the `midimonster` core, handling mapping
-- 
cgit v1.2.3