diff README @ 15:dec8e537cbf8

Update README, COPYRIGHT and runExperiment.bat example.
author Marcus Pearce <marcus.pearce@eecs.qmul.ac.uk>
date Tue, 17 Jan 2012 12:25:15 +0000
parents 85b03f084d63
children cd11981476ec
line wrap: on
line diff
--- a/README	Tue Jan 17 12:24:31 2012 +0000
+++ b/README	Tue Jan 17 12:25:15 2012 +0000
@@ -1,11 +1,11 @@
 AUTHOR
 
-Marcus Pearce <m.pearce@gold.ac.uk>
+Marcus Pearce <marcus.pearce@eecs.qmul.ac.uk>
 
 
 USAGE 
 
-  java Experiment <show clock?> <multiple> <n> <midi device> <scale length> <low anchor> <high anchor> <midi file directory> <instructions file> <familiarity> <pleasantness> <questionnaire>
+  java Experiment <show clock?> <multiple> <n> <midi device> <scale length> <low anchor> <high anchor> <midi file directory> <instructions file> <results directory> <familiarity> <pleasantness> <questionnaire>
 
 where <show clock?> specifies whether to show the clock (0 = no; 1 =
 yes) and <multiple> and <n> are integers: the clock runs for <n> time
@@ -25,6 +25,8 @@
 the participant which will be displayed at the beginning of the
 experiment.
 
+<results directory> is teh directory where the results will be written.
+
 If <familiarity> is 1 the participant is asked to rate the familiarity
 of each stimulus, if it is 0 the question is omitted.
 
@@ -40,38 +42,26 @@
 To use in a study:
 
 1. put the relevant midi files in the directory specified by <midi
-file directory> (e.g., Data/Midi/)
+file directory>. When playing the clock, the program can be a little 
+fussy about the onsets and durations of the notes in the midi files 
+being exact integer multiples of each other. 
 
 2. edit pfilelist.txt and filelist.txt (also in <midi file directory>)
 to contain the midi files played in the practice and main blocks
 respectively: put one file on each line followed by a list of note
 numbers to probe with the visual clock (e.g., 1 = the first note). 
-NB: that the last line of these files must terminate with a newline.
+NB: only use a single space between filenames and note numbers; 
+also, the last line of these files must terminate with a newline.
 
-3. edit Data/instructions.html if necessary or create a new set of
-instructions.
+3. create a set of instructions for the study in an html file.
 
-The results are written to files in the Results/ directory.
+The results are written to files in the specified directory which must
+exist.
 
 4. responses can be given either using the mouse or using the numeric
 keys (except in the case of a scalelength of 2 where the keys 'q' and
 'p' are used).
 
-FILES AND DIRECTORIES: 
-
-Data/: 
-  - instructions.html: the default instructions file 
-  - pfilelist.txt: the list of midi filenames in the practice block 
-  - filelist.txt: the list of midi filenames in the main block 
-  - Midi/: the location of the midi files specified above
-
-Results/: 
-  - the results are written to files in this directory 
-
-Icons/: 
-  - contains icons used for the GUI
-
-
 DEVELOPMENT 
 
 The code is organised according to a MVC structure: 
@@ -92,3 +82,8 @@
              - InterBlockPanel.java
 
 Controller: ExperimentController.java 
+
+Icons/:
+  - contains icons used for the GUI
+
+