diff README @ 7:e2242b4b0b3d

Allow instructions file to be passed as a command line argument. Ignore-this: 60e440775e698898e485f8f0dfbd3db
author Marcus Pearce <m.pearce@gold.ac.uk>
date Fri, 15 Jul 2011 16:36:53 +0100
parents ac0d14c9c9ab
children 235484b93707
line wrap: on
line diff
--- a/README	Thu Nov 25 11:12:24 2010 +0000
+++ b/README	Fri Jul 15 16:36:53 2011 +0100
@@ -5,7 +5,7 @@
 
 USAGE 
 
-  java Experiment <show clock?> <multiple> <n> <midi device> <scale length> <low anchor> <high anchor> <midi file directory>
+  java Experiment <show clock?> <multiple> <n> <midi device> <scale length> <low anchor> <high anchor> <midi file directory> <instructions file>
 
 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
@@ -21,6 +21,10 @@
 
 <midi file directory> is the directory where the midi files are stored
 
+<instructions file> is an html file containing the instructions for
+the participant which will be displayed at the beginning of the
+experiment.
+
 See runExperiment.bat for an example.
 
 To use in a study:
@@ -28,12 +32,14 @@
 1. put the relevant midi files in the directory specified by <midi
 file directory> (e.g., Data/Midi/)
 
-2. edit pfilelist.txt and filelist.txt (also in <midi file directory>) to
-contain the midi files played in the practice and main blocks
+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.
+numbers to probe with the visual clock. NB: that the last line of
+these files must terminate with a newline.
 
-3. edit Data/instructions.html if necessary.
+3. edit Data/instructions.html if necessary or create a new set of
+instructions.
 
 The results are written to files in the Results/ directory.
 
@@ -44,7 +50,7 @@
 FILES AND DIRECTORIES: 
 
 Data/: 
-  - instructions.html: the instructions file 
+  - 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