aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 22 insertions, 1 deletions
diff --git a/README.md b/README.md
index bcae9dd..e955d53 100644
--- a/README.md
+++ b/README.md
@@ -163,8 +163,15 @@ as arguments to the `make` invocation:
|---------------|-----------------------|-------------------------------|-------------------------------|
| 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 |
+| `install` | `DESTDIR` | empty | Destination directory for packaging builds |
+| `install` | `DEFAULT_CFG` | empty | Install path for default configuration file |
+| `install` | `PLUGINS` | `$(PREFIX)/lib/midimonster` | Install path for backend shared objects |
+| `install` | `EXAMPLES` | `$(PREFIX)/share/midimonster` | Install path for example configurations |
+
+Note that the same variables may have different default values depending on the target. This implies that
+builds that are destined to be installed require those variables to be set to the same value for the
+build and `install` targets.
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`.
@@ -175,6 +182,17 @@ for example
```
make jack.so
```
+#### Using the installer
+
+For easy installation on Linux, the [installer script](installer.sh) can be used:
+
+```
+wget https://raw.githubusercontent.com/cbdevnet/midimonster/master/installer.sh ./
+chmod +x ./installer.sh
+./installer.sh
+```
+This tool can also update MIDImonster automatically using a configuration file generated by the installer.
+To do so, run `midimonster-updater` as root on your system after using the installer.
#### Building for packaging or installation
@@ -192,6 +210,9 @@ make install
Depending on your configuration of `DESTDIR`, the `make install` step may require root privileges to
install the binaries to the appropriate destinations.
+To create Debian packages, use the debianization and `git-buildpackage` configuration on the `debian/master`
+branch. Simply running `gbp buildpackage` should build a package for the last tagged release.
+
#### Building for Windows
To build for Windows, you still need to compile on a Linux machine (virtual machines work well for this).