add installation instructions. prevent double-copy of licenses. skip build if targets are missing.

This commit is contained in:
Alex Birch 2018-06-10 11:27:19 +01:00
parent 3d276e95d4
commit 450a34d803
No known key found for this signature in database
GPG Key ID: 305EB1F98D44ACBA
2 changed files with 62 additions and 6 deletions

View File

@ -24,12 +24,23 @@ trap 'error ${LINENO}' ERR
declare -a BUILDS=("Debug" "Release")
for BUILD in "${BUILDS[@]}"
do
if [ -d "$MYDIR/build/$BUILD" ]; then
echo "Found $BUILD; archiving targets to build/$BUILD.tar.xz:"
ls "$MYDIR/build/$BUILD"
\cp -rf ../../LICENSE.txt "$MYDIR/build/$BUILD/LICENSE.txt"
\cp -rf ../../licenses_of_dependencies "$MYDIR/build/$BUILD/licenses_of_dependencies"
tar -hczf "$MYDIR/build/$BUILD.tar.xz" -C "$MYDIR/build/$BUILD" .
BUILDDIR="$MYDIR/build/$BUILD"
if [ -d "$BUILDDIR" ]; then
echo "Found build $BUILD"
if [[ -d "$BUILDDIR/juicysfplugin.app" \
&& -d "$BUILDDIR/juicysfplugin.component" \
&& -d "$BUILDDIR/juicysfplugin.vst" \
&& -d "$BUILDDIR/juicysfplugin.vst3" ]]; then
echo "Found in $BUILD all targets: .app, .component, .vst, .vst3"
echo "Archiving $BUILD targets to build/$BUILD.tar.xz:"
ls "$BUILDDIR"
\cp -rf "$MYDIR/how to install.txt" "$BUILDDIR/how to install.txt"
\cp -rf "$MYDIR/../../LICENSE.txt" "$BUILDDIR/LICENSE.txt"
\cp -rf "$MYDIR/../../licenses_of_dependencies" "$BUILDDIR/."
tar -hczf "$BUILDDIR.tar.xz" --exclude="libjuicysfplugin.a" -C "$MYDIR/build/$BUILD" .
else
echo "Did not find in $BUILD all targets: .app, .component, .vst, .vst3; skipping."
fi
else
echo "Missing $BUILD; skipping."
fi

View File

@ -0,0 +1,45 @@
Release contains:
```
juicysfplugin.app # standalone application, for playing around
juicysfplugin.component # AU plugin
juicysfplugin.vst # VST plugin
juicysfplugin.vst3 # VST3 plugin
```
====
To install plugins, move them to the following folder:
```
juicysfplugin.component -> ~/Library/Audio/Plug-Ins/Components/juicysfplugin.component
juicysfplugin.vst -> ~/Library/Audio/Plug-Ins/VST/juicysfplugin.vst
juicysfplugin.vst3 -> ~/Library/Audio/Plug-Ins/VST3/juicysfplugin.vst3
```
If the folder `~/Library/Audio/Plug-Ins/VST` (or Components, or VST3) does not yet exist, make the folder yourself.
A handy way to get to the folder `~/Library/Audio/Plug-Ins/` is to open Finder and use the "Go" keyboard shortcut:
⌘ + ⇧ + G
====
To install juicysfplugin.app, put it wherever you want (for example /Applications or ~/Applications).
If you cannot open juicysfplugin.app, try _right-clicking_ it, and choose Open from the right-click menu. This gives you a _different dialogue_, with a new option, "Open".
====
Here's some soundfonts to get you started:
- MuseScore's recommended soundfonts (includes MIT, GPL, other licenses)
- https://musescore.org/en/handbook/soundfonts-and-sfz-files#list
- FlameStudios' guitar soundfonts (GPL-licensed)
- http://www.flamestudios.org/free/Soundfonts
====
Full instructions here:
https://github.com/Birch-san/juicysfplugin/blob/master/README.md