blumia/juicysfplugin
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

simplify README now that linking, bundling, releasing is simpler

Browse Source
This commit is contained in:
Alex Birch 2018-06-10 00:41:12 +01:00
parent f8b354d158
commit 3d276e95d4
No known key found for this signature in database
GPG Key ID: 305EB1F98D44ACBA
1 changed files with 5 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -105,13 +105,6 @@ Input audio device doesn't matter. We only use MIDI as input.
Install XCode and XCode command line tools. Accept terms. Install XCode and XCode command line tools. Accept terms.
Ensure [brew](https://brew.sh/) and `libfluidsynth` are installed:
```bash
# --with-libsndfile is optional; it adds support for SF3 format
brew install fluidsynth --with-libsndfile
```
Install [JUCE](https://shop.juce.com/get-juce) 5.3 in `/Applications`. Install [JUCE](https://shop.juce.com/get-juce) 5.3 in `/Applications`.
We expect to find JUCE headers in `/Applications/JUCE/modules`. We expect to find JUCE headers in `/Applications/JUCE/modules`.
@ -124,6 +117,9 @@ Open `juicysfplugin/Builds/MacOSX/juicysfplugin.xcodeproj` in XCode (or IntelliJ
Build & run the "juicysfplugin - Standalone Plugin" target. Build & run the "juicysfplugin - Standalone Plugin" target.
All the libs we link against are project-local (see `juicysfplugin/Builds/MacOSX/lib_relinked`).
I have used `install_name_tool` to give these libs relative install names. This ensures that any product you build will be portable.
## Testing VST/AU plugins inside an audio plugin host ## Testing VST/AU plugins inside an audio plugin host
You'll notice that the schemes for [VST, VST3, AU, AUv3] targets are configured such that "Run" launches the executable `AudioPluginHost.app`. This lets you run the audio plugin as though it were hosted inside a DAW. You'll notice that the schemes for [VST, VST3, AU, AUv3] targets are configured such that "Run" launches the executable `AudioPluginHost.app`. This lets you run the audio plugin as though it were hosted inside a DAW.
@ -148,22 +144,16 @@ Known working with:
- VST3 Audio Plug-Ins SDK 3.6.9 - VST3 Audio Plug-Ins SDK 3.6.9
- fluidsynth 1.1.11 - fluidsynth 1.1.11
# Making portable releases # Making releases
Follow the steps in [Building from source](#building-from-source) to output a product to the build folder. Follow the steps in [Building from source](#building-from-source) to output a product to the build folder.
The .app, .vst (and so on) that you build will only work on a computer that has brew fluidsynth installed. Builds are automatically portable.
If you want to build a _truly portable release_, you'll need to _bundle libfluidsynth and all its dependencies_ into your product.
```bash ```bash
cd juicysfplugin/Builds/MacOSX cd juicysfplugin/Builds/MacOSX
# first check that you have a Release or Debug product in the `build` directory # first check that you have a Release or Debug product in the `build` directory
# bundles `juicysfplugin/lib` libs into the products you created,
# relinks your executables to use their bundled libs
./relink-build-for-distribution.sh
# follows symlinks, archives Release and Debug folders as tar.xz # follows symlinks, archives Release and Debug folders as tar.xz
./archive-for-distribution.sh ./archive-for-distribution.sh
``` ```
@ -171,9 +161,6 @@ cd juicysfplugin/Builds/MacOSX
Note: Release **and** Debug flavors _both_ output targets [VST, VST3, AU] to the same location: `~/Library/Audio/Plug-Ins/$TARGET/juicysfplugin.$EXT`. Note: Release **and** Debug flavors _both_ output targets [VST, VST3, AU] to the same location: `~/Library/Audio/Plug-Ins/$TARGET/juicysfplugin.$EXT`.
Whichever flavor you built _most recently_, wins. Whichever flavor you built _most recently_, wins.
The way I provide archives of _both_ build flavors is by archiving one, building next flavor, then archiving that (i.e. I build serially, not parallel).
But probably people only care about the Release flavor anyway.
# Licenses # Licenses
Overall, juicysfplugin is GPLv3. Overall, juicysfplugin is GPLv3.