From 552b82bbaf395dfdc51c645ec74b7dd6392e23d5 Mon Sep 17 00:00:00 2001 From: Irene Date: Fri, 4 Sep 2026 19:23:30 +0900 Subject: [PATCH] docs: update README to reflect completed DSP and fix stale references - Replace 'DSP not written yet' description with actual stereo delay DSP summary. - Update src/lib.rs description in project structure tree. - Replace stale 192.168.2.199 IP with pi5-16.local hostname in the clone URL (both in README body and Quick Start example). --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 226de38..c456e13 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,13 @@ A stereo delay/echo plugin — Rust, CLAP/VST3, egui. -Scaffolded from [`musiikki/nih-plug-template`](http://192.168.2.199:3005/musiikki/nih-plug-template); -the DSP is not written yet, the plugin currently passes audio through an example gain stage. +Scaffolded from [`musiikki/nih-plug-template`](http://pi5-16.local:3005/musiikki/nih-plug-template); +the DSP is a simple stereo delay with independent left/right delay lines, feedback, and a wet/dry mix control. ## Quick Start ```bash -git clone http://192.168.2.199:3005/musiikki/kolmekivi +git clone http://pi5-16.local:3005/musiikki/kolmekivi cd kolmekivi cargo xtask bundle kolmekivi --release --features vst3 ``` @@ -81,7 +81,7 @@ cp -r "target/bundled/Kolmekivi.vst3" ~/.vst3/ ``` Cargo.toml # Package deps + the opt-in `vst3` feature — NIH-plug pinned to codename-206's rev bundler.toml # Bundle name for `cargo xtask bundle` -src/lib.rs # Plugin skeleton — params, DSP, and egui editor, with one example gain param +src/lib.rs # Plugin — params, stereo delay DSP, and egui editor xtask/ # Bundler xtask (cargo xtask bundle) .cargo/config.toml # xtask alias tools/ # Branding toolkit — see Renaming