diff --git a/README.md b/README.md index febbd73..51ca90a 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,32 @@ # Frequalizer -This is a JUCE project using the new dsp module for an Equalizer. -It features: +[![Build Status](https://github.com/mttbernardini/frequalizer/actions/workflows/build.yml/badge.svg)](https://github.com/mttbernardini/frequalizer/actions/workflows/build.yml/badge.svg) -- six individual bands -- an input and an output analyser -- solo each band -- drag frequency and gain directly in the graph +This project provides a 6-band Parametric Equalizer built using [JUCE](https://github.com/juce-framework/JUCE) and the `juce::dps` module. -![Frequalizer Screenshot](https://raw.githubusercontent.com/ffAudio/Frequalizer/master/Resources/Screenshot.png) +The code is based on the work of [Foley Finest](https://github.com/ffAudio/Frequalizer) and has been forked in order to continue development for my personal needs, since, at the time of writing, the original project is unmaintaned since 2022. -[![CMake](https://github.com/ffAudio/Frequalizer/actions/workflows/workflow.yml/badge.svg)](https://github.com/ffAudio/Frequalizer/actions/workflows/workflow.yml) +**⚠️ Compatibiliy Note:** branding and IDs are replaced with my own! This plugin is NOT compatible with the original Foley Finest's Frequalizer and is treated as a different plug-in by Audio Hosts and DAWs. -Download a ready built package for Mac OSX plugins running as AU, VST, VST3 and AAX: -https://www.foleysfinest.com/plugins/frequalizer/ +## Download + +Pre-built VST3 or Audio Unit are available over the [Releases](https://github.com/mttbernardini/frequalizer/releases) page. + +After download, move the VST/AU file to the expected location of your OS. + +Note for macOS users: the Audio Unit is self-signed. To use it you will need to remove the quarantine flag using `xattr -rd com.apple.quarantine path/to/frequalizer.component` after downloading. + +## Build + +Clone this repo and its submodules: + + git clone --recurse-submodules https://github.com/mttbernardini/frequalizer + cd frequalizer + +Use CMake to build: + + cmake -B build + cmake --build build + +You'll find the built plugins under `dist/`. diff --git a/SETUP_CI.md b/SETUP_CI.md deleted file mode 100644 index bc27680..0000000 --- a/SETUP_CI.md +++ /dev/null @@ -1,21 +0,0 @@ -Setup Github actions -==================== - -For my own memory this is how the github actions can be configured -to codesign and create an installer. This is mostly learned from this blog post: -https://localazy.com/blog/how-to-automatically-sign-macos-apps-using-github-actions - -The code can be seen in this repositories file .github/workflows/workflow.yml - -Create certificate ------------------- - -Create a "Developer ID Application" certificate and import it in your "Keychain Access" -Open Keychain Access and select the certificate and the private key (expand the -certificate, select both and select "Export 2 items"). Save it as .p12. - -Save the p12 as base64 and copy the result in a repository secret MACOS_CERTIFICATE. -Place the password you chose in a repository secret MACOS_CERTIFICATE_PWD. - - -