From 96fe966928cd83f22aed388a11013b67c1a374a1 Mon Sep 17 00:00:00 2001 From: cbdev Date: Fri, 6 Dec 2019 18:58:59 +0100 Subject: Make install path for examples configurable --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index bcae9dd..9bcd913 100644 --- a/README.md +++ b/README.md @@ -159,12 +159,13 @@ For Linux and OSX, just running `make` in the source directory should do the tri 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 | +| Target | Parameter | Default value | Description | +|-------------------------------|-----------------------|-------------------------------|-------------------------------| +| build targets, `install` | `DEFAULT_CFG` | `monster.cfg` | Default configuration file | +| build targets, `install` | `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` | `EXAMPLES` | `$(PREFIX)/share/midimonster` | Install path for example configurations | 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`. -- cgit v1.2.3 From 0468b5c5fafe0b6d72d8cd05613da3e705fa25c3 Mon Sep 17 00:00:00 2001 From: cbdev Date: Fri, 6 Dec 2019 19:05:41 +0100 Subject: Update the build parameters section with some explanations --- README.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 9bcd913..c7fd3c1 100644 --- a/README.md +++ b/README.md @@ -159,13 +159,19 @@ For Linux and OSX, just running `make` in the source directory should do the tri 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, `install` | `DEFAULT_CFG` | `monster.cfg` | Default configuration file | -| build targets, `install` | `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` | `EXAMPLES` | `$(PREFIX)/share/midimonster` | Install path for example configurations | +| 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` | `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` | Destination directory for packaging builds | +| `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`. -- cgit v1.2.3 From 01c8635205e25ba2e6c128010ad512cf03868bc2 Mon Sep 17 00:00:00 2001 From: cbdev Date: Fri, 6 Dec 2019 19:07:25 +0100 Subject: Fix variable description --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index c7fd3c1..785d741 100644 --- a/README.md +++ b/README.md @@ -166,7 +166,7 @@ as arguments to the `make` invocation: | `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` | Destination directory for packaging builds | +| `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 -- cgit v1.2.3 From 7e59d4832f819abe0bc981ebdac20f6e12a031e7 Mon Sep 17 00:00:00 2001 From: Spacelord Date: Fri, 6 Dec 2019 22:28:04 +0100 Subject: Added update to README --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 785d741..1f22657 100644 --- a/README.md +++ b/README.md @@ -182,6 +182,14 @@ for example ``` make jack.so ``` +#### Buiding with Installer + +For easy installation, the following steps are required: + +``` +wget https://raw.githubusercontent.com/cbdevnet/midimonster/master/installer.sh ./ +./installer.sh +``` #### Building for packaging or installation -- cgit v1.2.3 From 553633e0ab0191756bb5b8810a461168dfc66a3d Mon Sep 17 00:00:00 2001 From: Spacelord Date: Fri, 6 Dec 2019 22:37:40 +0100 Subject: added chmod +x to Installer README --- README.md | 1 + 1 file changed, 1 insertion(+) (limited to 'README.md') diff --git a/README.md b/README.md index 1f22657..e925541 100644 --- a/README.md +++ b/README.md @@ -188,6 +188,7 @@ For easy installation, the following steps are required: ``` wget https://raw.githubusercontent.com/cbdevnet/midimonster/master/installer.sh ./ +chmod +x ./installer.sh ./installer.sh ``` -- cgit v1.2.3 From 34b8dd5c71615724408022db37dcf94576a12280 Mon Sep 17 00:00:00 2001 From: cbdev Date: Fri, 6 Dec 2019 22:51:56 +0100 Subject: Add link to installer section --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 1f22657..9052034 100644 --- a/README.md +++ b/README.md @@ -184,7 +184,7 @@ make jack.so ``` #### Buiding with Installer -For easy installation, the following steps are required: +For easy installation on Linux, the [installer script](installer.sh) can be used: ``` wget https://raw.githubusercontent.com/cbdevnet/midimonster/master/installer.sh ./ -- cgit v1.2.3 From 1bb3b9a3eaf94af045c39a1ff1ee8bf9b8e5b8ec Mon Sep 17 00:00:00 2001 From: cbdev Date: Sat, 7 Dec 2019 20:22:03 +0100 Subject: Mention debianization in README --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 454284f..8d38565 100644 --- a/README.md +++ b/README.md @@ -182,7 +182,7 @@ for example ``` make jack.so ``` -#### Buiding with Installer +#### Using the installer For easy installation on Linux, the [installer script](installer.sh) can be used: @@ -208,6 +208,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). -- cgit v1.2.3 From 704f256475ad52ab96e42f7b10ca407fac13d313 Mon Sep 17 00:00:00 2001 From: Spacelord Date: Wed, 18 Dec 2019 21:43:01 +0100 Subject: Mention updater in README + Updater Improvements --- README.md | 2 ++ 1 file changed, 2 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 8d38565..e955d53 100644 --- a/README.md +++ b/README.md @@ -191,6 +191,8 @@ 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 -- cgit v1.2.3