audio/gelyk
2
1
Fork 0
mirror of https://codeberg.org/armin/gelyk.git synced 2026-10-11 17:01:53 +02:00
Code Issues Projects Releases Packages Wiki Activity

fix dashes

Browse source
This commit is contained in:
Armin 2026-08-30 14:22:24 +02:00
commit 49eb039050
1 changed files with 15 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

28
README.md
View file

@ -7,7 +7,7 @@ A minimalist **7-band parametric equalizer** with a cyber/neon UI, built on
This README is intentionally verbose: it covers what the plugin *is*, how it is
structured, how every band behaves, and how to build it from source on any
platform — including Linux/Artix without the WebKitGTK/GTK developer headers.
platform - including Linux/Artix without the WebKitGTK/GTK developer headers.
---
@ -49,25 +49,25 @@ state between sessions via a JUCE `AudioProcessorValueTreeState`.
### On-screen controls
- **The visualiser** — the main field shows:
- **The visualiser** - the main field shows:
- the **live input spectrum** (a realtime FFT analyser), drawn as a glowing,
filled waveform;
- the **static summed EQ curve** (the actual filter response), overlaid on the
same log-frequency axis so peaks line up with their bands;
- the neon **0 dB centre line** and reference grid.
- **Per-band faders** — drag a band vertically to change its gain, horizontally
- **Per-band faders** - drag a band vertically to change its gain, horizontally
to move its frequency, or use the mouse wheel to nudge its Q. The knobs and
numeric readouts below each fader are permanently linked to it.
- **LEVEL / FREQ / Q knobs** — an alternative, precise way to edit the currently
- **LEVEL / FREQ / Q knobs** - an alternative, precise way to edit the currently
hovered band.
- **MASTER fader** — output trim.
- **SENS slider** — vertical offset for the live spectrum trace (how visually
- **MASTER fader** - output trim.
- **SENS slider** - vertical offset for the live spectrum trace (how visually
"hot" the analyser appears; the display is pre-tuned to real per-FFT-bin
levels, so it reads meaningfully without touching this).
- **WAVE slider** — opacity of the live spectrum waveform.
- **HUE / SAT / BRI sliders** — recolor the entire palette (colour-shift, global
- **WAVE slider** - opacity of the live spectrum waveform.
- **HUE / SAT / BRI sliders** - recolor the entire palette (colour-shift, global
saturation and brightness) for a custom neon look.
- **SCALE selector** — fractional UI scaling for high-DPI or small screens.
- **SCALE selector** - fractional UI scaling for high-DPI or small screens.
- A **status bar** shows the build version and, when the plugin is built from a
git checkout, the current branch/commit and dirty state.
@ -79,8 +79,8 @@ state between sessions via a JUCE `AudioProcessorValueTreeState`.
|---------------|--------------------------|--------------------------|
| Band fader | Vertical = gain | Adjusts band Q |
| | Horizontal = frequency | |
| Per-band knobs| Rotate = value | — |
| Master fader | Vertical = output gain | — |
| Per-band knobs| Rotate = value | - |
| Master fader | Vertical = output gain | - |
Double-click any knob or fader to reset it to its default value.
@ -117,7 +117,7 @@ renders (aggregated into log-spaced bins from 20 Hz to 20 kHz).
### Requirements
- **CMake 3.15+** and a C++17 compiler (Clang, GCC, or MSVC).
- [JUCE 8.0.7](https://github.com/juce-framework/JUCE) — fetched automatically
- [JUCE 8.0.7](https://github.com/juce-framework/JUCE) - fetched automatically
by CMake via `FetchContent` when `JUCE_ROOT` is not set. To reuse an existing
checkout, configure with `-DJUCE_ROOT=/path/to/JUCE`.
@ -141,7 +141,7 @@ make install # copy into ~/Library/Audio/Plug-Ins and codesign
### Linux / Artix note (no GTK or WebKitGTK headers required)
The plugin **does not depend on GTK or WebKitGTK developer headers**, so it
builds cleanly on minimal/headless-flavored distros such as **Artix** — no
builds cleanly on minimal/headless-flavored distros such as **Artix** - no
`webkit2gtk`, `gtk3`-devel, `libsoup` or `jsc` packages needed.
This is guaranteed in `CMakeLists.txt`:
@ -150,7 +150,7 @@ This is guaranteed in `CMakeLists.txt`:
target_compile_definitions(GelykEQ PRIVATE JUCE_WEB_BROWSER=0)
```
JUCE's Linux `FileChooser` in JUCE 8 no longer links GTK either — it shells out
JUCE's Linux `FileChooser` in JUCE 8 no longer links GTK either - it shells out
to `zenity`/`kdialog` at runtime, and Gelyk never opens a native file dialog.
Disabling `JUCE_WEB_BROWSER` removes the WebKitGTK-backed `WebBrowserComponent`
(which Gelyk does not use), eliminating the entire GTK/WebKit include chain.