tuxmain/HexoDSP
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

more documentation

Browse source
This commit is contained in:
Weird Constructor 2022-07-19 06:02:13 +02:00
parent 5b1aa9a9e3
commit f8a0ebb447
1 changed files with 13 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
src/dsp/mod.rs
View file

@ -10,17 +10,24 @@
When adding a new node to HexoDSP, I recommend working through the following checklist: When adding a new node to HexoDSP, I recommend working through the following checklist:
- [ ] Implement boilerplate - [ ] Implement boilerplate in node_yourname.rs
- [ ] Document boilerplate - [ ] Add input parameter and output signal definition to dsp/mod.rs
- [ ] Document boilerplate in node_yourname.rs
- [ ] DSP implementation - [ ] DSP implementation
- [ ] Parameter fine tuning - [ ] Parameter fine tuning
- [ ] DSP tests for all params - [ ] DSP tests for all (relevant) params
- [ ] Ensure Documentation is properly formatted for the GUI - [ ] Ensure Documentation is properly formatted for the GUI
- [ ] Add CHANGELOG.md entry in HexoSynth - [ ] Add CHANGELOG.md entry in HexoSynth
- [ ] Add CHANGELOG.md entry in HexoDSP - [ ] Add CHANGELOG.md entry in HexoDSP
- [ ] Add table entry in README.md in HexoSynth - [ ] Add table entry in README.md in HexoSynth
- [ ] Add table entry in README.md in HexoDSP - [ ] Add table entry in README.md in HexoDSP
The boilerplate can be a bit daunting. But it pays off, because HexoSynth will give
you a GUI for your DSP code for free at the end.
Generally I recommend starting out small. Define your new node with minimal parameters
until you get the hang of all the things involved to make it compile in the first place.
Here are some hints to get you started: Here are some hints to get you started:
### Boilerplate ### Boilerplate
@ -61,6 +68,9 @@ can not be automated.
### Node Documentation ### Node Documentation
**Attention: Defining the documentation for your DSP node is not optional. It's required to make
it compile in the first place!**
Every DSP node must come with online documentation. The online documentation is what makes the Every DSP node must come with online documentation. The online documentation is what makes the
node usable in the first place. It's the only hint for the user to learn how to use this node. node usable in the first place. It's the only hint for the user to learn how to use this node.
Keep in mind that the user is not an engineer, but usually a musician. They want to make music Keep in mind that the user is not an engineer, but usually a musician. They want to make music