more refactoring and doc updates

iandol · Feb 8, 2022 · 1d6ae26 · 1d6ae26
1 parent b1a91da
commit 1d6ae26
Show file tree

Hide file tree

Showing 32 changed files with 2,097 additions and 968 deletions.
diff --git a/.doxyfile b/.doxyfile
diff --git a/CoreProtocols/AreaSummation.mat b/CoreProtocols/AreaSummation.mat
diff --git a/CoreProtocols/DotColour.mat b/CoreProtocols/DotColour.mat
diff --git a/CoreProtocols/DotDirection.mat b/CoreProtocols/DotDirection.mat
diff --git a/CoreProtocols/Isoluminant_Colours.mat b/CoreProtocols/Isoluminant_Colours.mat
diff --git a/CoreProtocols/Isoluminant_Colours_StateInfo.m b/CoreProtocols/Isoluminant_Colours_StateInfo.m
diff --git a/CoreProtocols/RFLocaliserStateInfo.m b/CoreProtocols/RFLocaliserStateInfo.m
@@ -1,12 +1,17 @@
-%RFLOCALISER state configuration file, this gets loaded by opticka via
-% runExperiment class. 
+% RFLOCALISER state configuration file, this gets loaded by opticka via
+% runExperiment class. This protocol allows you to elicit visual responses
+% while a subject maintains fixation.
 %
-% This protocol uses mouse and keyboard control of many different classes
-% of stimuli. You can change which stimulus and what variables are during
-% the task, while the subject maintains fixation. 
+% This protocol uses mouse and keyboard control of 10 different classes of
+% stimuli. You can change which stimulus and what variables are during the
+% task, while the subject maintains fixation. See Help > Keyboard Map for
+% the keys; basically < and > change stimuli, ← and → change the variable,
+% and ↑ and ↓ change the variable value (see stims.controlTable below for
+% the actual values). You can also change the fixation time etc.
 %
-% The following class objects (easily named handle copies) are already 
-% loaded and available to use. Each class has methods useful for running the task: 
+% The following class objects (easily named handle copies) are already
+% loaded and available to use. Each class has methods useful for running
+% the task:
 %
 % me		= runExperiment object
 % s			= screenManager

diff --git a/METHODS.md b/METHODS.md
diff --git a/Opticka Keyboard Mapping.odt b/Opticka Keyboard Mapping.odt
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@ Opticka is an object-oriented framework with optional GUI for the [Psychophysics
 
 ## Sample hardware setup
 
-The diagram below shows an sample Opticka configuration setup; note that the eyetracker, display and electrophysiology systems can be swapped for other hardware ([see the list below](#Hardware-currently-supported)):  
+The diagram below shows a sample Opticka configuration setup. Note that the eyetracker, display, synchronisation and electrophysiology systems can be swapped for other hardware ([see the list below](#Hardware-currently-supported)). While I prefer using a Display++ or a DataPixx/ViewPixx to ensure temporal fidelity, you can use a LabJack or arduino for synchronisation (where a photodiode becomes more important):  
 
 ![Example hardware setup to run Opticka](https://github.com/iandol/opticka/raw/gh-pages/images/Opticka-Setup.png)
 
@@ -48,7 +48,7 @@ runDemo(sM);
 There is also auto-generated class documentation here: [Opticka Class Docs](http://iandol.github.io/OptickaDocs/inherits.html), that details the major classes and their methods and properties. This is generated from the comments in the code, which as always could be improved…  
 
 ## Basic Install Instructions
-See [**Detailed instructions**](INSTALL.md) for full install details…
+See [**Detailed instructions**](help/INSTALL.md) for full install details…
 
 Opticka prefers the latest Psychophysics Toolbox (V3.0.17+) and at least Matlab 2017a (it uses object-oriented property validation introduced in that version). It has been tested on 64bit Ubuntu 20.04 & macOS 12.x with **MATLAB 2021b** (newer versions are generally faster). You can simply download the [GitHub ZIP File](https://github.com/iandol/opticka/archive/refs/heads/master.zip), unzip and CD to the folder and run `addOptickaToPath.m`. Or to keep easily up-to-date if you have git installed, clone this Github repo, CD to the folder then run `addOptickaToPath.m`.
 

diff --git a/INSTALL.md → help/INSTALL.md b/INSTALL.md → help/INSTALL.md