Update faust2api documentation.

grame-cncm · Jan 2, 2025 · c0574f3 · c0574f3
1 parent 29dcf61
commit c0574f3
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 5 deletions.
diff --git a/architecture/api/README.md b/architecture/api/README.md
@@ -17,6 +17,7 @@ Most major Faust targets are supported:
 * JACK
 * PortAudio
 * RTAudio
+* Miniaudio
 * openFrameworks
 * JUCE
 * Teensy
@@ -34,7 +35,6 @@ The various options of `faust2api` can be displayed at any point by running:
 
 `faust2api` is part of the [Faust distribution](https://github.com/grame-cncm/faust). To use it, Faust must be properly installed on your system (read the Faust README in the previous link to get more information on how to do that).
 
-
 Common options for all platforms:
 
 - `-opt native|generic`: to activate the best compilation options for the native or generic CPU.
@@ -45,14 +45,12 @@ Common options for all platforms:
 - `-nozip` : prevents generated files to be put in a zip file.
 - `-target <target>`: sets a name of the target folder or the zip file. Defaults to "dsp-faust"
 
-
-Options supported by iOS, CoreAudio, ALSA, JACK, PortAudio, openFrameworks and JUCE:
+Options supported by iOS, CoreAudio, ALSA, JACK, PortAudio, RTAudio, Miniaudio, openFrameworks and JUCE:
 
 - `midi`: add built-in RtMidi support to the API.
 - `osc`: add built-in OSC support to the API.
 - `soundfile`: add built-in Soundfile support to the API.
 
-
 ### Android Support
 
 To turn a Faust code into an Android API, just run the following command:
@@ -133,6 +131,17 @@ faust2api -rtaudio yourFaustCode.dsp
 The `-midi` option can be used to add RtMidi support to the API.
 The `-osc` option can be used to add OSC support to the API.
 
+### Miniaudio Support
+
+To turn a Faust code into an Miniaudio API, just run the following command:
+
+```
+faust2api -miniaudio yourFaustCode.dsp
+```
+
+The `-midi` option can be used to add RtMidi support to the API.
+The `-osc` option can be used to add OSC support to the API.
+
 ### OpenFrameworks Support
 
 To turn a Faust code into an openFrameworks API, just run the following command:

diff --git a/tools/faust2appls/faust2api b/tools/faust2appls/faust2api
@@ -90,7 +90,6 @@ echoHelp()
     echo
     echo "Android specific options:"
     option -package "set the JAVA package name (e.g. '-package mypackage' will change the JAVA package name to 'mypackage.DspFaust'). The default package name is 'com.DspFaust.'"
-    option -soundfile "add built-in Soundfile support to the API"
     echo
     echo "Options supported by iOS, CoreAudio, ALSA, JACK, PortAudio, RTAudio, Miniaudio, openFrameworks and JUCE"
     option -midi "add built-in RtMidi support to the API"