musiikki/kolmekivi
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update README to reflect completed DSP and fix stale references

Browse Source 
- 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).
This commit is contained in:
Irene Koivisto
2026-09-04 19:23:30 +09:00
parent 360c18ee0a
commit 552b82bbaf
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+4 -4
View File
@@ -2,13 +2,13 @@
A stereo delay/echo plugin — Rust, CLAP/VST3, egui. 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); Scaffolded from [`musiikki/nih-plug-template`](http://pi5-16.local:3005/musiikki/nih-plug-template);
the DSP is not written yet, the plugin currently passes audio through an example gain stage. the DSP is a simple stereo delay with independent left/right delay lines, feedback, and a wet/dry mix control.
## Quick Start ## Quick Start
```bash ```bash
git clone http://192.168.2.199:3005/musiikki/kolmekivi git clone http://pi5-16.local:3005/musiikki/kolmekivi
cd kolmekivi cd kolmekivi
cargo xtask bundle kolmekivi --release --features vst3 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 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` 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) xtask/ # Bundler xtask (cargo xtask bundle)
.cargo/config.toml # xtask alias .cargo/config.toml # xtask alias
tools/ # Branding toolkit — see Renaming tools/ # Branding toolkit — see Renaming