From 6ebf6dd04aeb0f129950fa77ca42c2f2759a1d0c Mon Sep 17 00:00:00 2001 From: Armin Date: Wed, 5 Aug 2026 20:05:38 +0200 Subject: [PATCH] Add vim swap ignore and README build/install instructions --- .gitignore | 4 +++- README.md | 25 +++++++++++++++++++++++-- 2 files changed, 26 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index b2507f7..190a750 100644 --- a/.gitignore +++ b/.gitignore @@ -17,6 +17,7 @@ CMakeOutput.log CMakeError.log cmake-build-*/ Makefile +!Makefile *.ninja # Xcode @@ -31,7 +32,8 @@ DerivedData/ .vs/ *.sublime-project *.sublime-workspace -*.swp +*.sw[a-p] +.*.sw[a-p] *~ # macOS diff --git a/README.md b/README.md index d269c28..633f50d 100644 --- a/README.md +++ b/README.md @@ -46,15 +46,36 @@ The VST3 plugin is written to: build/MonoStep_artefacts/Release/VST3/MonoStep.vst3 ``` -### Installing +### Quick start with make -Copy the bundle into your DAW's VST3 directory: +A `Makefile` wraps configure, build, and install. Just run `make`: + +```sh +make # build the plugin and copy it into ~/Library/Audio/Plug-Ins/VST3/ +make test # build and run the headless host test +make clean # remove the build directory +``` + +### Installing (manual copy) + +The VST3 plugin ships as a macOS bundle (`MonoStep.vst3`). Copy the whole +bundle into your DAW's VST3 directory: ```sh cp -R build/MonoStep_artefacts/Release/VST3/MonoStep.vst3 \ ~/Library/Audio/Plug-Ins/VST3/ ``` +Notes for macOS: + +- The per-user VST3 directory is `~/Library/Audio/Plug-Ins/VST3/`; create it + with `mkdir -p` if it does not exist. A system-wide copy would go to + `/Library/Audio/Plug-Ins/VST3/` but requires `sudo`. +- When updating, remove the old bundle first (`rm -rf` on the `MonoStep.vst3` + inside the target directory) so stale files do not remain. +- Your DAW may cache the plugin list — quit and relaunch it (or rescan plugins) + after installing before looking for MonoStep. + ## Running the tests Build the headless host test and run it against the built plugin: