Adds a README file for the examples folder

README.md

@@ -27,10 +27,9 @@ Fixed point arithmetics are performed in q16 format; 16 bits for the integer par
 
 Vult provides a few templates; for example to generate objects compatible with the Teensy Audio Library or Pure Data externals.
 
-You can see these repositories for examples:
+You can check these repositories for examples:
 
-- PureData https://github.com/modlfo/vult-examples
-- PureData https://github.com/modlfo/pd-vult-example
+- PureData https://github.com/modlfo/vult/examples
 - Teensy Audio https://github.com/modlfo/teensy-vult-example
 
 In the Wiki

examples/CMakeLists.txt

@@ -51,7 +51,7 @@ vult_pd(svf filters/svf.vult VULT_INCLUDES)
 
 vult_pd(saturate effects/saturate.vult VULT_INCLUDES)
 vult_pd(saturate_soft effects/saturate_soft.vult VULT_INCLUDES)
-vult_pd(short_delay effects/delay.vult VULT_INCLUDES)
+vult_pd(short_delay effects/short_delay.vult VULT_INCLUDES)
 vult_pd(bitcrush effects/bitcrush.vult VULT_INCLUDES)
 
 # UNITS

examples/README.md

@@ -0,0 +1,38 @@
+# Vult Examples
+
+![Examples](/other/Images/synths.png?raw=true "Examples")
+
+A set of Vult examples where each file is a standalone module that can be compiled to PureData or used to assemble more complex patches.
+
+The modules follow these conventions:
+
+* Pitch: 0.1 per octave, where 0.0 corresponds to C1
+* Audio: -1.0 to 1.0
+* Envelopes: 0.0 to 1.0
+* Gates: 0.0 to 1.0
+
+This convention lousy correspond to the typical Eurorack convention but divided by 10.0.
+
+The examples are organized in the following folders:
+
+* effects : Effects (e.g. Delay, Saturation)
+* env : Envelopes (e.g. ADSR, LFO)
+* filters : Filters (e.g. Ladder, State Variable)
+* midi : MIDI utilities (e.g. MIDI to CV)
+* osc : Oscillators (e.g. Saw, square)
+* units : Full units (e.g. combination of the other modules)
+* util : Utilities
+
+## Build the Modules
+
+To build the modules as PD externals you need to have installed [cmake](https://cmake.org) and the Vult compiler needs to be in your path as [vultc].
+
+```
+$ cd examples
+$ mkdir build
+$ cd build
+$ cmake ../
+$ make
+```
+
+After building, all the PD externals will be available in the [build] directory. To use them with PD you need to include this directory in the start path of PD.

examples/cmake/pd.cmake

@@ -38,6 +38,11 @@ function(vult_pd output source includes)
       set(includes_flag -i ${dir} ${includes_flag})
    endforeach(dir)
 
+   # check the file
+    execute_process(
+      COMMAND ${VULT} ${includes_flag} -check ${source}
+      WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR})
+
    # get the dependencies
    execute_process(
       COMMAND ${VULT} ${includes_flag} -deps ${source}