Browse Source

Improve documantation.

faust
Stephane Letz Andrew Belt 4 years ago
parent
commit
a81672d018
1 changed files with 4 additions and 4 deletions
  1. +4
    -4
      Faust.md

+ 4
- 4
Faust.md View File

@@ -4,11 +4,11 @@ The [Faust audio DSP language](https://faust.grame.fr) can be used in VCV Protot

## Compiling on OSX

The Faust *libfaust* dynamic library has to be available in your system. You can get is from a precompiled Faust release (simpler), or compile it yourself (harder). Then the [Faust aware VCV Prototype](https://github.com/sletz/VCV-Prototype) can be compiled and installed.
The Faust *libfaust* dynamic library has to be available in your system. You can get it from a precompiled Faust release (simpler), or compile it yourself (harder). Then the [Faust aware VCV Prototype](https://github.com/sletz/VCV-Prototype) can be compiled and installed.

### Installing the *libfaust* dynamic library from a precompiled package:

- go on Faust [release page](https://github.com/grame-cncm/faust/releases) and get the latest .dmg for OSX.
- go on Faust [release page](https://github.com/grame-cncm/faust/releases) and get the latest .dmg for OSX
- mount the disk image and copy the 3 *libfaust.dylib*, *libfaust.2.dylib* and *libfaust.x.y.z.dylib* files located in the disk image */lib* folder in your system */usr/local/lib* folder

### Compiling the *libfaust* dynamic library:
@@ -19,7 +19,7 @@ The Faust *libfaust* dynamic library has to be available in your system. You can
### Compiling the VCV Prototype:

- clone the [Faust aware VCV Prototype](https://github.com/sletz/VCV-Prototype) then type `make && make install` to build it
- you can now add a Faust aware VCV Prototype in your Rack session and start coding in Faust.
- you can now add a Faust aware VCV Prototype in your Rack session and start coding in Faust

## Loading/editing/compiling .dsp files

@@ -27,7 +27,7 @@ Faust DSP files have to be loaded in VCV Prototype and edited in a external edit

The 6 *switches*, *knobs* as well as the *lights* and *switchLights* can be connected to UI controllers using metadata:

- `[switch:N]` (with N from 1 to 6) has to be used in a `button` or `checkbox` item to connect it to the prototype interface switch number N.
- `[switch:N]` (with N from 1 to 6) has to be used in a `button` or `checkbox` item to connect it to the prototype interface switch number N. Pushed buttons will become red when on, and checkboxes will become white when on.
- `[knob:N]` (with N from 1 to 6) has to be used in a `vslider`, `hslider` or `nentry` item to connect it to the prototype interface knob number N.
- `[light_red|green|red:N]` (with N from 1 to 6) has to be used in a `vbargraph` or `hbargraph` item to connect it to the prototype interface light number N.
- `[switchlight_red|green|red:N]` (with N from 1 to 6) has to be used in a `vbargraph` or `hbargraph` to connect it to the prototype interface switchLight number N.


Loading…
Cancel
Save