Documentation Requirement: Verified Step-by-Step Examples for Running DSP

[Asher-]

It is surprisingly frustrating to piece together which forms of output are suited to which hardware, and exactly how to combine that code. For example, there is no "mac os" option; I assume that audiokit is the preferred target, but this is a set of 3rd party libraries, and no explanation is given how to combine the dsp code with a default audiokit project. I can figure this out (and will plan to add details once I do), but there is no question that this is a barrier to entry for most people.

In a similar vein, the VST target does not seem to document its dependencies (apparently VST SDK 2, which is no longer available), and the faustvst target does not clarify its relation to the vst target.

My suggestion:

• There should be a platform list that describes options that can be deployed to the given platform, including suggestions as to which options are preferred.
• Any target should provide documentation to compile a working example on any supported platform. This should be a one-stop solution to demoing a compiled example.

I hope to help contribute to this, so I am primarily posting this here to make note of a gaping hole in the Faust distribution.

[sletz]

See https://faustdoc.grame.fr/manual/tools/

[Asher-]

That doesn't match what I described or resolve any of the issues.

As I said: I was able to use the tools just fine. Connecting the code (in the example of audiokit) was not so clear. But also, some of the tools have requirements that are not clarified. The page you link, for example, does not clarify how to sort out the VST issue (see other bug rep)

[sletz]

Better use https://faustide.grame.fr (see https://github.com/grame-cncm/faustide for some documentation)

[Asher-]

How will that help me get an instance running on mac os?

Maybe I'm not seeing features that exist. I will read all the docs.

[Asher-]

Marking this as closed is absolutely absurd. This does not exist. Pretending it does just alienates new potential users and contributors.

[sletz]

• https://faustdoc.grame.fr/manual/tools/ describes part of the information you need (platform, package requirement), and some more explanations added like a few hours ago
• if you want to improve it, please contribute. This project is open-source and contributions are welcomed.
• but behaving the way you do is probably no the best way to start a proper contribution

[josmithiii]

Greetings - it sounds like you want to make a VST3 plugin using Faust. Here is how I do it: https://ccrma.stanford.edu/courses/320c-spring-2022/assignments/15/

[Asher-]

Thanks @josmithiii!

@sletz As I made clear, I am asking these questions in light of work toward contributing. I'm not sure what behavior you are referring to. Closing the issue without addressing the issue was patronizing and rude. Particularly when the question was asked in the context of figuring out how to start contributing. The URL you provide does not in any way line up with the information that I asked about. It documents the --help output for the tools, which is already readily available. As I made clear, the issue concerns, for example, how to connect the code output, for example in the example of audiokit, with audiokit code. Similarly with the non-working VST tool. It seems to me that your response is the one embodying a behavior issue.

[sletz]

The I suggest opening a specific issue for audiokit, to make it more clear, and I've re-opened the VST one.

[Asher-]

I will do that as well, but the issue is so much bigger than that. The project is a MESS. Which is quite surprising given how clean the code is (even if stylistically from the 90s).

I aim to fix this.

[sletz]

The project is a MESS.

You mean the code in https://github.com/grame-cncm/faust/tree/master-dev/architecture/audiokit ? Well this was something done as complete blind developed code. I am happy to help improving it. See also https://faustdoc.grame.fr/manual/architectures/ as general explanations on architecture files.