initialHEADmaster

1 files changed, 35 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b28cec6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+# csound-cueextract : extract cues from a file
+
+## Overview
+This provides a simple opcode for extracting the sample points of cue markers from a supported file type, such as wav. Up to 100 cue points per file are supported as governed by the underlying libsndfile default maximum. The cue points are presented as samples, so to determine the point in seconds, that should be divided by the sample rate of the file.
+
+## Requirements
+* Cmake >= 2.8.12
+* Csound with development headers >= 6.14.0
+* libsndfile
+
+
+
+## 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
+An example is provided in the examples directory.
+
+
+## Opcode reference
+
+### icues[] cueextract Sfile
+Description
+
+* icues[] : cue points in the file, presented in samples
+
+* Sfile : file to examine for cue points
+