Skip to content

Commit

Permalink
docs: update readme, delete unneeded file
Browse files Browse the repository at this point in the history
  • Loading branch information
mttbernardini committed May 7, 2024
1 parent 12f0248 commit 9ec31c2
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 31 deletions.
35 changes: 25 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -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/`.
21 changes: 0 additions & 21 deletions SETUP_CI.md

This file was deleted.

0 comments on commit 9ec31c2

Please sign in to comment.