HOTFIX automerge issues in docs

README.md

@@ -7,7 +7,9 @@ Rigbox is a high-performance, open-source MATLAB toolbox for managing behavioral
 
 ## Requirements
 
-For exploring Rigbox's features and running test experiments, Rigbox only needs to be installed on a single computer.
+For running full experiments Rigbox requires two PCs: one for presenting stimuli and one for monitoring the experiment.  Currently only National Instruments DAQs are supported for acquiring data from hardware devices.  For testing, the toolbox can be run on a single machine.  
+
+### Software
 
 Rigbox has the following software dependencies:
 * **OS:** Windows 7 or later, 64-bit
@@ -32,18 +34,13 @@ Below are a few minimum hardware requirements for both PCs.  Precise requirement
 **Graphics:** NVIDIA Quadro P400 (or similar)  
 **Memory:** DDR4 16 GB @ 2133 MHz (e.g. Corsair Vengeance 16 GB)   
 
-### Software
+## Installation
 
 Below are short instructions for installing Rigbox for users familiar with Git and MATLAB.  For detailed instructions, please see the [installation guide](https://cortex-lab.github.io/Rigbox/install.html).
 
 Before starting, ensure the above toolboxes and packages are installed.  PsychToobox can not be installed via the MATLAB AddOns browser.  See [Installing PsychToobox](#Installing-PsychToolbox) for install instructions.  
 
-* OS: 64 Bit Windows 7 or later
-* Libraries: Visual C++ Redistributable Packages for Visual Studio [2013](https://www.microsoft.com/en-us/download/details.aspx?id=40784) & [2015](https://www.microsoft.com/en-us/download/details.aspx?id=48145)
-* MATLAB: 2017b or later, including the Data Acquisition Toolbox
-* Community MATLAB toolboxes:
-	* [GUI Layout Toolbox](https://uk.mathworks.com/matlabcentral/fileexchange/47982-gui-layout-toolbox) (v2 or later)
-	* [Psychophysics Toolbox](http://psychtoolbox.org/download.html#Windows) (v3 or later)
+It is highly recommended to install Rigbox via the [Git Bash](https://git-scm.com/download/win) terminal*. 
 
 1. To install Rigbox, run the following commands in the Git Bash terminal to clone the repository from GitHub to your local machine.
 ```
@@ -54,16 +51,16 @@ git clone --recurse-submodules https://github.com/cortex-lab/Rigbox
 \* Accepting all installer defaults will suffice.  
 ** To add the paths temporarily for testing, run `addRigboxPaths('SavePaths', false, 'Strict', false)`
 
-Before starting, ensure you have read and followed the above [requirements section](#requirements).
+### Installing PsychToolbox
 
-Below we provide brief instructions for installing Rigbox via Git. For a detailed installation guide, including installing Rigbox's software dependencies, see [here](https://cortex-lab.github.io/Rigbox/detailed_installation.html).
+PsychToolbox-3 is required for visual and auditory stimulus presentation.  Below are some simple steps for installing PsychToolbox.  For full details see [their documentation](http://psychtoolbox.org/download.html#Windows).
 
 1. Download and install a Subversion client.  [SilkSVN](https://sliksvn.com/download/) is recommended.
 2. Download and install the [64-Bit GStreamer-1.16.0 MSVC runtime](https://gstreamer.freedesktop.org/data/pkg/windows/1.16.0/gstreamer-1.0-msvc-x86_64-1.16.0.msi).  Make sure all offered packages are installed.
 3. Download the MATLAB [installer function](https://raw.githubusercontent.com/Psychtoolbox-3/Psychtoolbox-3/master/Psychtoolbox/DownloadPsychtoolbox.m) from the PsychToolbox GitHub page.
 4. Call the function in MATLAB with the target install location (folder must exist) and follow the instructions:
 ```
-git clone --recurse-submodules https://github.com/cortex-lab/Rigbox
+DownloadPsychtoolbox('C:\') % Install to C drive
 ```
 
 ## Getting started
@@ -80,22 +77,25 @@ For more infomation on using the Signals Test GUI see [this guide](https://corte
 ### Running an experiment
 For running full experiments see the [Setting up experiments](https://cortex-lab.github.io/Rigbox/index.html#2) guide.  This will guide you through configuring a visual viewing model, configuring audio devices and setting up hardware that requires a DAQ.  
 
-For information on running experiments via MC and SC, see Rigbox's [index page](https://github.com/cortex-lab/Rigbox/blob/dev/docs/html/index.html). This page also contains information on setting up Rigbox (see also [`docs/setup`](https://github.com/cortex-lab/Rigbox/tree/master/docs/setup)) and using certain Rigbox features (see also [`docs/usage`](https://github.com/cortex-lab/Rigbox/tree/master/docs/setup)) after an MC and SC installation. Furthermore, this page gives an overview of the repository's organization.
+Information specific to the steering wheel task can be found on the [CortexLab website](https://www.ucl.ac.uk/cortexlab/tools/wheel).
 
 ## Updating the code
-
-With Git it's very easy to keep the code up-to-date. We strongly recommend regularly updating Rigbox and its submodules by running the following git commands (within the Rigbox directory):
+With Git it's very easy to keep the code up-to-date.  To update Rigbox and all submodules at the same time, run the following in the Git Bash terminal (within the Rigbox directory):
 ```
 git pull --recurse-submodules
 ```
 
+When calling `srv.expServer` and `mc`, the code is automatically updated if a new stable release is available.  This behvaiour can be configured with the 'updateSchedule' field in your `+dat/paths.m` file.
+
 ## Contributing
 
-If you experience a bug or have a feature request, please report them on the [GitHub Issues page](https://github.com/cortex-lab/Rigbox/issues). To contribute code, we encourage anyone to open up a pull request into the dev branch of Rigbox or one of its submodules. Ideally you should include documentation and a test with your feature. Please read [CONTRIBUTING.md](https://github.com/cortex-lab/Rigbox/blob/master/CONTRIBUTING.md) for details on how to contribute code to this repository and our code of conduct.
+If you experience a bug or have a feature request, please report them on the [GitHub Issues page](https://github.com/cortex-lab/Rigbox/issues).  To contribute code we encourage anyone to open up a pull request into the dev branch of Rigbox or one of its submodules.  Ideally you should include documentation and a test with your feature.
+
+Please read [CONTRIBUTING.md](https://github.com/cortex-lab/Rigbox/blob/dev/CONTRIBUTING.md) for further details on how to contribute, as well as maintainer guidelines and our code of conduct.
 
 ## Authors & Accreditation
 
-Rigbox was created by [Chris Burgess](https://github.com/dendritic/) in 2013, initially developed to probe mouse behavior for the [Steering Wheel Setup](https://www.ucl.ac.uk/cortexlab/tools/wheel). It is now maintained and developed by Miles Wells ([email protected]), Jai Bhagat ([email protected]) and a number of others at [CortexLab](https://www.ucl.ac.uk/cortexlab). See also the full list of [contributors](https://github.com/cortex-lab/Rigbox/graphs/contributors).
+Rigbox was started by [Chris Burgess](https://github.com/dendritic/) in 2013. It is now maintained and developed by Miles Wells ([email protected]), Jai Bhagat ([email protected]) and a number of others at [CortexLab](https://www.ucl.ac.uk/cortexlab). See also the full list of [contributors](https://github.com/cortex-lab/Rigbox/graphs/contributors).
 
 For further information, see [our publication](https://www.biorxiv.org/content/10.1101/672204v3). Please cite this source appropriately in publications which use Rigbox to acquire data.