diff README @ 0:4031cbb02f08

Initial import.
Ignore-this: 87317e384f22bde48db996355191fa5f

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Tue May 18 11:37:10 2010 +0100
@@ -0,0 +1,65 @@
+AUTHOR
+
+Marcus Pearce <[e-mail]>
+
+
+USAGE 
+
+  java Experiment <multiple> <n> <scale length> <low anchor> <high anchor>
+
+where <multiple> and <n> are integers: the clock runs for <n> time
+units before a probed event where the time unit is a multiple of the
+tatum as specified by <multiple>. <scale length> is the number of
+levels of the rating scale and <low anchor> and <high anchor> are its
+high and low anchors respectively (e.g., "highly unexpected", "highly
+expected" with a scale length of 7). See runExperiment.bat for an example.
+
+To use in a study:
+
+1. put the relevant midi files in Data/Midi;
+
+2. edit pfilelist.txt and filelist.txt 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.
+
+3. edit Data/instructions.html if necessary.
+
+The results are written to files in the Results/ directory.
+
+
+FILES AND DIRECTORIES: 
+
+Data/: 
+  - instructions.html: the 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: 
+
+Model:      Experiment.java 
+             - FileList.java           
+             - ProbeID.java
+             - MidiPlayer.java
+             - MelodyResults.java   
+             - SubjectResults.java
+             - Block.java 
+
+View:       ExperimentGui.java 
+             - Clock.java
+             - InstructionsPanel.java
+             - StimulusPanel.java
+             - SubjectDataPanel.java
+             - InterBlockPanel.java
+
+Controller: ExperimentController.java