update readme

README.md

@@ -1,48 +1,90 @@
-
 # DEL2
 
-A delay that you play like an instrument.
+The delay that you play.
 
 https://github.com/user-attachments/assets/cd501d5a-0c7d-404d-b970-8f6272594568
 
+In VST3 and CLAP format, for Linux, Mac and Windows.
+
+
+## Features & Quickstart
+
+- **Midi rhythm delay**  
+You record a delay rhythm by playing midi notes into the plugin.  
+The first note starts counting, and each note after that creates a delay tap, with a maximum of 16. 
+
+- Independent **effects per tap** 
+  - A **moog style filter** with creamy drive
+  The parameters are (optionally) linked to velocity and note.
+  - **Panning**, linked to the note
+- Four **midi triggers:**
+  - **mute input**
+  - **mute output**
+  - **clear taps**
+  - **lock taps**
+  - There are two modes for the input and output mute: "toggle" and "direct":
+    - **Toggle-mode** is how most mutes work: the triggers turn the mute on when it's off and vice versa.
+    - **Direct-mode** is more like an instrument: the mute is on by default and the trigger turns it off only as long as you hold the trigger note.
+- The rhythm pattern is saved alongside the other parameters in the preset and DAW session.
+- Stereo from end to end
+
+## Manual
+
+### Installation
+Download the zip from [here](https://github.com/magnetophon/DEL2/releases/tag/V0.3.0), unpack it, and copy the .vst3 or .clap to your plugin folder.  
+Mac users will have to [disable GateKeeper](https://disable-gatekeeper.github.io/)
+
+### Before you start
+- Connect a midi source.  
+This can be an instrument, a foot-pedal, a sequencer, or anything else that sends midi.
+- Connect an audio source.  
+Most DAWs allow you to send a live or recorded audio track into the plugin, alongside the midi from the previous step.  
+You could also put an instrument plugin before DEL2 and use the audio from that.
+
+### Recording a rhythm
+The first note starts counting, and each note after that creates a delay tap.  
+The **max tap** slider sets how long a tap can take.  
+The pink line in the graph shows how much time there is left to add new taps to the rhythm  
+Every time you add a tap, the counter resets.  
+**min tap** is the minimum time between two taps, mainly for de-bouncing, but it can also be used creatively.  
+**sync** lets you choose between a free running delay, or one synced to the host tempo.  
+BPM mode doesn't quantize the tap timing; it just changes the duration of the taps when the host tempo changes.  
+**listen to** lets you choose which midi channel the rhythm notes come from: "any channel", or 1 to 16
+
+### Filters
+There's a set of filter parameters for low velocity and one for high velocity.  
+Each individual filter follows the velocity of the tap.  
+You can also link the note to the cutoff frequency, to play melodies with the resonance.  
+**vel>cut** sets how much influence the velocity has on the cutoff.  
+**note>cut** sets how much influence the notes have on the cutoff.  
+**drive** lets you adjust how much the filter distorts  
+If the input is loud, high drive can sound quieter than low drive.  
+**mode** lets you choose between low-pass, high-pass, and notch filters of various steepness.
+
+### Panning
+By playing lower or higher notes, you pan each tap to the left or right.  
+The first note determines the center of the stereo image   
+The **center** slider allows you to change that to another note.  
+**panning amount** controls how much each note is panned.  
+
+Not just the delay and the filter, but also the panner is fully stereo.  
+Instead of turning down the level for one channel a lot, when you want tox pan to the other side, these panners ad a tiny bit more delay to one side, and they make that side slightly duller and quieter.  
+The overall effect is that the sound seems to be coming from the opposite side.  
+The signal retains it's stereo-width:  sounds that where coming from the opposite side of where you panned, will still mostly come from there.
+
+### Triggers
+To set which note controls the trigger, just click the button and play a note.  
+  - There are two modes for the input and output mute: "toggle" and "direct":  
+    - **Toggle-mode** is how most mutes work: the triggers turn the mute on when it's off and vice versa.  
+    - **Direct-mode** is more like an instrument: the mute is on by default and the trigger turns it off only as long as you hold the trigger note.  
+it also (retroactively) turns the other mute off when you press it.  
+  **attack** and **release** set how long it takes for the mute to turn on or off.  
+
+### Other parameters
+**dry/wet** mix between the unaltered dry signal and the effect.  
+**wet gain**this is a post effect make up gain.  
+**global drive*** lets you adjust the overall amount of distortion.  
 
-## Current features
-
-- Tap a rhythm into it using midi
-- Each delay tap has a separate moog style filter
-  - The filter parameters are pair of settings, and each tap's settings is an interpolation between these two, depending on the velocity
-  - You can also link the cutoff frequency to the note
-- A haas panner that you can link to the note 
-- 4 triggers, controlled by a learnable midi note:
-  - mute input
-  - mute output
-  - clear taps
-  - lock taps
-- There are two modes for the input and output mute: toggle-mode and direct-mode:
-  - In toggle-mode, the trigger note for mute toggles the respective mute
-  - In direct-mode, the trigger note switches it on when you press it, and off when you let it go
-    The note also (retroactively) turns the other mute off when you press it.
-- The status of the triggers and the current tap pattern are saved and retrieved alongside the preset or DAW session.
-
-## Planned features
-
-- Expand the DSP per tap to:
-  - two non-linear filters
-  - a reverb
-  - a HRTF panner
-  - a pitch shifter that shifts the difference between the initial timing tap note and the current tap note
-  - a Karplus-Strong per tap, at the pitch of the note
-- Compressor and ducker on the output
-- Optional individual settings per tap
-- Optional auxiliary outputs per tap
-- BPM sync, scale and quantization
-- Tap the rhythm using your computer keyboard or side-channel audio
-- A third mode for the mutes:
-  - In instrument-mode, the first note you play will be silent, and start recording a new pattern, as always.
-    The next eight notes will be like playing an sampler, that plays the sample you started recording at the beginning of the pattern.
-    When you let go of a note, the tap will start the release phase.
-    The state of the mute switches will determine if a note turns on and off the input, the output, or both.
-    When you switch to instrument-mode, it turns on "mute in" and turns off "mute out", so by default the notes you play
 
 ## Thanks
 
@@ -52,4 +94,4 @@ This plugin would not have been possible without the following projects:
 - [va-filter](https://github.com/Fredemus/va-filter)
 - [synfx-dsp](https://github.com/WeirdConstructor/synfx-dsp)
 
-I would like to thank [Robbert van der Helm](https://github.com/robbert-vdh), [Fredemus](https://github.com/Fredemus) and [WeirdConstructor](https://github.com/WeirdConstructor) for their fantastic support and feedback!   
+I would like to thank [Robbert van der Helm](https://github.com/robbert-vdh), [Dr George Atkinson](https://github.com/geom3trik), [Fredemus](https://github.com/Fredemus) and [WeirdConstructor](https://github.com/WeirdConstructor) for their fantastic support and feedback!