ReproNim / reprostim

Automated capture of audio-visual stimuli into BIDS datasets
5 stars 3 forks source link

Add service file and instructions to README.md on how to set it all up #11

Open yarikoptic opened 4 years ago

yarikoptic commented 4 years ago

README.md should

yarikoptic commented 1 year ago

Andy , please provide basic documentation on how to use the thing, since I have tried and without looking into the code it is impossible:

❯ ./VideoCapture
usage: ./VideoCapture -d <path> [-o <path> | -h ]
    -d <path>   REPROSTIM_HOME directory (not optional)
    -o <path>   Output directory where to save recordings (optional)
        Defaults to $REPROSTIM_HOME/Videos
    -c </path/to/config.yaml>   Path to configuration file (optional)
        Defaults to $REPROSTIM_HOME/config.yaml
    -h      Print this help string

❯ mkdir -p myhome/outputs
❯ ./VideoCapture -d myhome -o myhome/outputs
terminate called after throwing an instance of 'YAML::BadFile'
  what():  bad file: myhome/config.yaml
[1]    3442075 IOT instruction (core dumped)  ./VideoCapture -d myhome -o myhome/outputs
❯ fg
_set_cmd_xterm_title:jobs:22: no current job
fg: no current job
❯ 
❯ touch myhome/config.yaml
❯ ./VideoCapture -d myhome -o myhome/outputs
2023.01.26.18.16.29: <><><> Starting VideoCapture <><><>
    <> Saving Videos to     ===> myhome/outputs
    <> Recording from Video Device  ===> 

^C

so what should be in that config file -- is it described anywhere?