update README

This commit is contained in:
David Braun 2025-01-09 10:28:11 -05:00
parent 41603bc837
commit 02223009ba
2 changed files with 5 additions and 0 deletions

View file

@ -3,6 +3,8 @@ name: Python package
on: on:
push: push:
branches: [ "main" ] branches: [ "main" ]
paths-ignore:
- "README.md"
pull_request: pull_request:
branches: [ "main" ] branches: [ "main" ]
release: release:

View file

@ -36,6 +36,7 @@ print("potential sources:", vita.get_modulation_sources())
print("potential destinations:", vita.get_modulation_destinations()) print("potential destinations:", vita.get_modulation_destinations())
# "lfo_1" and "filter_1_cutoff" are potential sources and destinations. # "lfo_1" and "filter_1_cutoff" are potential sources and destinations.
# Let's use "lfo_1" as a source and "filter_1_cutoff" as a destination.
assert synth.connect_modulation("lfo_1", "filter_1_cutoff") assert synth.connect_modulation("lfo_1", "filter_1_cutoff")
controls = synth.get_controls() controls = synth.get_controls()
@ -69,6 +70,8 @@ synth.load_init_preset()
synth.clear_modulations() synth.clear_modulations()
``` ```
Documentation is not yet automated. Please browse [bindings.cpp](https://github.com/DBraun/Vita/blob/main/src/headless/bindings.cpp) to get a sense of how the code works.
### Issues ### Issues
If you find any issues with the code, report them at https://github.com/DBraun/Vita. If you find any issues with the code, report them at https://github.com/DBraun/Vita.