Skip to content

Commit

Permalink
README: a simpler configuration overview
Browse files Browse the repository at this point in the history
  • Loading branch information
nzjrs committed Dec 29, 2020
1 parent 7b11fda commit da92f07
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,10 +103,27 @@ optional arguments:

TLDR;

* FlyVR reads its configuration from the command line and one or more files
* `-c config.yml`
is the main configuration and *can* contain *both* the rig-specific configuration
*and* the experiment playlist
* Example rig configurations can be found in the `configs` directory.
* `-p playlist.yml`
contains *only* the definition of the stimulus playlist. Any other configuration
is ignored.
* Sample playlists can be found in the `playlists` directory
* By allowing separating the playlist and rig-specific configuration (such as how the
DAQ is wired) one can use the same playlists on multiple rigs.
* It is however not necessary to have *both* a `config.yml` and a `playlist.yml` - they
can be combined into `config.yml` if desired
* More information on the configuration possibilities can be found in the
[configuration](#configuration) section

If you are developing a stimulus playlist (video example, substitute for audio as appropriate)

* copy an example playlist e.g. copy 'playlists/video1.yml' to 'myvideo.yml'
* exit, test and experiment on the playlist using the single launcher `flyvr-video.exe --config myvideo.yml`

When you have finished the playlist and experiment development and wish to run on a rig

* create a rig-specific config file (see templates in configs/) with the electrical connections
Expand Down

0 comments on commit da92f07

Please sign in to comment.