diff --git a/README.md b/README.md index b36058f..1f8febb 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,87 @@ Noise Gate → Compressor → Distortion → EQ → Output - C++ compiler - JUCE is downloaded automatically by CMake +--- + ## Build on macOS +### Requirements + +Install CMake and Ninja: + +```bash +brew install cmake ninja +``` + +Xcode Command Line Tools are also required: + +```bash +xcode-select --install +``` + +### Build + ```bash cmake --preset mac-release -cmake --build --preset mac-release \ No newline at end of file +cmake --build --preset mac-release +``` + +The VST3 plugin is automatically installed to: + +```text +~/Library/Audio/Plug-Ins/VST3/Crille Bass Strip.vst3 +``` + +--- + +## Build on Windows + +### Requirements + +Install: + +- Git +- CMake +- Ninja +- Visual Studio 2022 Build Tools with **Desktop development with C++** + +Rider can be used as the IDE. + +### Build + +Open a terminal in the project directory and run: + +```powershell +cmake --preset windows-release +cmake --build --preset windows-release +``` + +The resulting plugin will be: + +```text +Crille Bass Strip.vst3 +``` + +VST3 plugins on Windows are normally installed in: + +```text +C:\Program Files\Common Files\VST3 +``` + +--- + +## Plugin Formats + +Currently supported: + +- VST3 +- Standalone + +## Platforms + +- macOS +- Windows + +## Author + +Christian Ohlsson \ No newline at end of file