chris/nymph
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: update readme

Browse Source 
Signed-off-by: Christopher Arndt <chris@chrisarndt.de>
This commit is contained in:
Christopher Arndt 2024-09-29 14:18:07 +02:00
parent 1f72523055
commit 4dcfd1abdb
1 changed files with 13 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -22,12 +22,19 @@ Install the `amp.lv2` example plugin:
cp -a examples/amp.lv2 ~/.lv2 cp -a examples/amp.lv2 ~/.lv2
Other example plugins can be found in the [examples](./examples) directory and Other example plugins can be found in the [examples](./examples) directory and
can be built and tested with similar commands, just changing the example name can be built and tested with similar commands. Just change the example name to
to the basename of the plugin's LV2 bundle dir. the basename of the plugin's LV2 bundle dir.
Currently, there are only two other example plugins, `multimode_filter` and Currently, there are just a few other example plugins:
`miditranspose`, but more will be added in due time.
* `miditranspose`: shows how to handle receiving and sending MIDI events.
* `multimodefilter`: shows a multimode state-variable filter implementation
ported from C++ to Nim.
* `tiltfilter`: shows a multimode tilt equalizer filter implementation ported
from Rust to Nim.
* `faustlpf`: shows how to integrate DSP C code generated from a [FAUST]
source file in Nim (in this example the FAUST code implements a simple
non-resonant low-pass filter from the FAUST standard library).
## How To ## How To
@ -67,7 +74,7 @@ Currently, there are only two other example plugins, `multimode_filter` and
--out:myplugin.lv2/libmyplugin.so myplugin.nim --out:myplugin.lv2/libmyplugin.so myplugin.nim
See the definition of the `build_ex` task in the See the definition of the `build_ex` task in the
[nymph.nimble](./nymph.nimble#L43) file on how to create a nimble task [nymph.nimble](./nymph.nimble#L67) file on how to create a nimble task
to simplify compilation. to simplify compilation.
@ -83,8 +90,8 @@ Optional:
* [lv2lint] - For checking conformity of plugin bundles * [lv2lint] - For checking conformity of plugin bundles
[FAUST]: https://faust.grame.fr/
[LV2]: https://lv2plug.in/ [LV2]: https://lv2plug.in/
[lv2bm]: https://github.com/moddevices/lv2bm [lv2bm]: https://github.com/moddevices/lv2bm
[lv2lint]: https://git.open-music-kontrollers.ch/~hp/lv2lint [lv2lint]: https://git.open-music-kontrollers.ch/~hp/lv2lint
[Nim]: https://nim-lang.org/ [Nim]: https://nim-lang.org/