Skip to content

Commit da973e6

Browse files
committed
add documentation in the readme file for devSandbox
1 parent 22a00eb commit da973e6

File tree

2 files changed

+19
-1
lines changed

2 files changed

+19
-1
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,24 @@ Define the parameters of the fixation cross in `cfg` and `expParameters` and thi
140140

141141
Use that to stop your script and only restart when the space bar is pressed.
142142

143+
## Annexes
144+
145+
### Experiment template [ WIP ]
146+
147+
### `devSandobox.m` stand-alone
148+
149+
This script is a stand-alone function that can be useful as a sandbox to develop the PTB audio/visual stimulation of your experiment. No input/output required.
150+
151+
Here, a tutorial from https://peterscarfe.com/contrastgratingdemo.html is provided for illustrative purpose (notice that some vars' name are updated to our code style). For your use, you will delete that part.
152+
153+
It is composed of two parts:
154+
- a fixed structure that will initialize and close PTB in 'debug mode'
155+
(`PsychDebugWindowConfiguration`, `SkipSyncTests`)
156+
- the actual sandbox where to set your dynamic vars (the stimualtion
157+
parameters) and the 'playground' where to develop the stimulation code
158+
159+
When you are happy with it, ideally you will move the vars in `setParameters.m` and the stimulation code in a separate function in `my-experiment-folder/subfun`. The code style and vars name is the same used in `cpp-lln-lab/CPP_PTB` github repo, therefore it should be easy to move everything in your experiment scripts (see the template that is annexed in `cpp-lln-lab/CPP_PTB`).
160+
143161
## Contributors ✨
144162

145163
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

devSandbox.m

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
% This script is a stand-alone function that can be useful as a sandbox to
44
% develop the PTB audio/visual stimulation of your experiment. No input/output
5-
% recquired.
5+
% required.
66
%
77
% Here, a tutorial from https://peterscarfe.com/contrastgratingdemo.html is
88
% provided for illustrative purpose (notice that some vars' name are updated

0 commit comments

Comments
 (0)