Active Configuration - Camilla DSP

[TNT]

Ok, looks like there may be some issues with the documentation. There is no need for any of that, there are pre-build .exe files that you just need to download from the releases page. Any ideas on how I can make this more clear in the readme?



Yes the dsp engine is a command line tool, so this is as expected. But the documentation might not make this clear. Any suggestions for improvements to avoid disappointment like this?

For most and many, installing a tool 2025 would mean that it comes with a GUI. So even if the documentation is perfectly correct (and very good!), I think it needs to catch the less knowledgeable first and then, tend to the experts - they survive anyways

First pedagogic problem:

- Structure of your Github - it is divided into camilla components (perfect I'm sure!) - this is for a newbie not an easy environment to understand.
- Your working name of "the whole thing" is CamillaDSP but a problem is that one of the components have the exact same name - misinterpretation possible and evident,,,,
- There are for a newbie complicated prerequisites for the software environment for a complete install that includes also the GUI that might not be obvious (py)

To catch the newbies it is probably necessary to present a very high level decision graph in the very beginning of the "install" chapter of the CamillaDSP component page - and even on some other components pages that might want to point to the CamillaDSP Install section because newbies might end up there after some guurgling...

The solution:

As the very first part of the Install chapter:

"Are you looking to try out Camilla DSP - answer the below easy questions and we will guide you to success:

- Do you want to install CDSP including a GUI managing Camilla? Go here -> A
- Do you want to just install the Camilla DSP engine with CLI configuration? Go here -> B
- Do you want to build your special version of CamillaDSP? Go here -> C

A) What type platform:

- Mac -> M
- Linux
- Win

M)

Do:
- Create a phyton environment
- Complete install incl. GUI (script)
- Start CDSP
- Create configuration
- Enjoy music...

L)

W)

...

Perhaps a step-by-step is too much but at least a overall guide to steer the new user to an understanding of the overall structure and installation would still help many I think.

//

 

[HenrikEnquist]

Thanks for this, I finally got around to read it properly.

First pedagogic problem:

- Structure of your Github - it is divided into camilla components (perfect I'm sure!) - this is for a newbie not an easy environment to understand.

Yes it's divided like this for technical reasons. The problem here is that github is a repository for the source code, but what would be needed is a proper website covering the entire camilladsp project.

- Your working name of "the whole thing" is CamillaDSP but a problem is that one of the components have the exact same name - misinterpretation possible and evident,,,,

This would be easier to explain on the (not yet existing) camilladsp website. I have thought of creating one, with a proper domain name etc, but haven't found the time. For now, I added a short intro in the camilladsp (engine) readme: https://github.com/HEnquist/camilladsp/blob/next31/README.md#camilladsp

As the very first part of the Install chapter:

"Are you looking to try out Camilla DSP - answer the below easy questions and we will guide you to success:

- Do you want to install CDSP including a GUI managing Camilla? Go here -> A
- Do you want to just install the Camilla DSP engine with CLI configuration? Go here -> B
- Do you want to build your special version of CamillaDSP? Go here -> C

This would also fit nicely on that website that doesn't exist
Maybe some day, but a challenge is that, for me, making such a website is far less interesting than working on the dsp itself..

 

[TNT]

a short intro in the camilladsp (engine) readme

In this intro and for the engine part I would make a few changes/additions to read:... It's by itself a functioning command-line controlled application that runs on Linux, macOS, and Windows.

//