changeset 23:644b35ca6909

added some meaningful info to the README
author luisf <luis.figueira@eecs.qmul.ac.uk>
date Thu, 05 Sep 2013 17:36:56 +0100
parents 8f1a16a22325
children ad6701ca3456
files audio_chord_estimation/chordino/README.txt
diffstat 1 files changed, 19 insertions(+), 6 deletions(-) [+]
line wrap: on
line diff
--- a/audio_chord_estimation/chordino/README.txt	Thu Sep 05 14:18:44 2013 +0100
+++ b/audio_chord_estimation/chordino/README.txt	Thu Sep 05 17:36:56 2013 +0100
@@ -1,10 +1,23 @@
+# MIREX 2013 submission
+#
+# Audio Chord Estimation
+# Chris Cannam, chris.cannam@eecs.qmul.ac.uk
 
-this script is UNFINISHED!
+# Dependencies
 
-* Harte format output by Chordino does not superficially seem to match
-  that in the submission guidelines
+- Sonic Annotator v1.0
+  http://code.soundsoftware.ac.uk/projects/sonic-annotator/files
 
-* Command line calling format in the guidelines differs from most of
-  the other categories (because it explicitly allows for training
-  phase)
+- Typical Unix/GNU shell commands
 
+# How to run
+
+In a terminal window run:
+
+./doChordID.sh /path/to/testFileList.txt /path/to/scratch/dir /path/to/results/dir  
+
+We do not use a training stage, so the second argument will be simply ignored.
+
+
+
+