grame-cncm / faust

Functional programming language for signal processing and sound synthesis
http://faust.grame.fr
Other
2.58k stars 322 forks source link

faust2atomsnippets usage documentation #760

Closed umlaeute closed 2 years ago

umlaeute commented 2 years ago

faust2atomsnippets is not listed in faust2appls/README.md, and calling it will show:

$ faust2atomsnippets 
At least one file argument required
usage: /usr/bin/faust2atomsnippets [-s][-t tabsize] file ...

now almost all faust2appls take a DSP-file (e.g. faust2jack mycode.dsp), but faust2atomsnippets does not, instead it expects a list of .lib files:

faust2atomsnippets *.lib

This is documented as a comment inside the implementation https://github.com/grame-cncm/faust/blob/91aa53805b51d4f11feb8030b21bd6baca98e81b/tools/faust2appls/faust2atomsnippets#L4, but really one shouldn't have to need to read the source code to understand what the app does.

i therefore suggest to:

sletz commented 2 years ago

PR welcome.

umlaeute commented 2 years ago

sure. i'll submit a fix for the usage-printout in a second. however, I'll leave the README update as an exercise to the reader, as I don't really know what to put in as a short description.