diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..598afad --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ +# csound-template : template for Csound plugins + +## Overview +Description here + +## Requirements +* Cmake >= 2.8.12 +* Csound with development headers >= 6.14.0 + + + +## Installation +Create a build directory at the top of the source tree, execute *cmake ..*, *make* and optionally *make install* as root. If the latter is not used/possible then the resulting library can be used with the *--opcode-lib* flag in Csound. +eg: + + mkdir build && cd build + cmake .. + make && sudo make install + +Cmake should find Csound and any other required libraries using the modules in the cmake/Modules directory and installation should be as simple as above. + +## Examples +Some examples are provided in the examples directory. + + +## Opcode reference + +### iout opcode iin +Description + +* iout : output + +* iin : input + |