abclib icon indicating copy to clipboard operation
abclib copied to clipboard

Are there docs?

Open DBraun opened this issue 2 years ago • 2 comments

Is there something like https://faustlibraries.grame.fr/ for abclib?

DBraun avatar Apr 24 '22 21:04 DBraun

The GRAME Faust libraries documentation is generated using scripts located here. They could be adapted to generate the documentation for other libraries.

sletz avatar Apr 25 '22 06:04 sletz

Thank you Stéphane.

@David: It is true we miss documentation for abclib, at least an efficient documentation of each function that could be extracted from the code. We are on the way to redesign abc.lib, and continue to move functions that are connected to ambisonics or spatial sound processing to hoa.lib (for the moment to hoa2.lib) and functions for mixed music to mm.lib (a future Faust library for mixed music). We will start the documentation effort when these migrations will be over.

Best,

Alain

Le lun. 25 avr. 2022 à 08:46, Stéphane Letz @.***> a écrit :

The GRAME Faust libraries documentation is generated using scripts located here https://github.com/grame-cncm/faustlibraries/tree/master/doc. They could be adapted to generate the documentation for other libraries.

— Reply to this email directly, view it on GitHub https://github.com/alainbonardi/abclib/issues/8#issuecomment-1108138817, or unsubscribe https://github.com/notifications/unsubscribe-auth/ACHLYFF3RFMKGI7UQKRVD2LVGY5U7ANCNFSM5UG2GYPQ . You are receiving this because you are subscribed to this thread.Message ID: @.***>

alainbonardi avatar Apr 25 '22 11:04 alainbonardi