diff --git a/README.md b/README.md index 4306a32..c85b215 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ Lamb was made with these goals in mind: The secret sauce is all in the attack/release: you can change both the length and the shape of their curve. -The shapes look like [this](https://www.desmos.com/calculator/cog4ujr7cs); _c0_ in Desmos corresponds to the _shape_ parameter in the plugin. +The shapes look like [this](https://www.desmos.com/calculator/cog4ujr7cs); _c0_ in Desmos corresponds to the _shape_ parameters in the plugin. When it is at value 0, the curve is a slice of pure sine. The ``release hold`` parameter prevents the gain reduction from coming back up if it needs to go down again soon. @@ -21,14 +21,14 @@ You control how soon is soon with ``release hold``. This adds latency though. -## Building +## Building and installing -After installing [Rust](https://rustup.rs/) and [Faust](https://faust.grame.fr), you can compile lamb as follows: +After installing [Rust](https://rustup.rs/), you can build and install lamb as follows: ```shell git submodule update --init --recursive -./build.sh -./install.sh +cargo xtask bundle lamb --release +cp -r target/bundled/lamb.vst3 ~/.vst3 ``` ## User preferences @@ -46,5 +46,17 @@ cargo xtask bundle lamb --release --features faust-rebuild The smoothing algorithm in lamb needs double precision to work. This only recently [got supported](https://github.com/grame-cncm/faust/commit/9f2eb5766605f9f8235a45965c69ff33b4274685) in faust and is not in a released version yet. -Therefore, you currently need to build faust from source to be able to rebuild the dsp of lamb. +Therefore, you currently need to build faust from source to be able to rebuild the dsp of lamb. +[Here's](https://github.com/grame-cncm/faust/wiki/BuildingSimple) a quick tutorial on how to do that. + + +## Thanks + +This plugin would not have been possible without the following projects: +- [Faust](http://faust.grame.fr) +- [nih-plug](https://github.com/robbert-vdh/nih-plug) +- [lowpass-lr4-faust-nih-plug](https://codeberg.org/obsoleszenz/lowpass-lr4-faust-nih-plug) + +I would like to thank @sletz, @robbert-vdh, @obsoleszenz and @dariosanfilippo for their fantastic support and feedback! + 🐑