Skip to content

Commit

Permalink
HOTFIX: Correct location of docs in README; Stronger wording in insta…
Browse files Browse the repository at this point in the history
…ll instructions
  • Loading branch information
k1o0 committed Sep 16, 2019
1 parent 9ff87fc commit 4ff1a21
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
7 changes: 5 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@

Starting after Rigbox 2.2.0, this file contains a curated, chronologically ordered list of notable changes made to the master branch. Each bullet point in the list is followed by the accompanying commit hash, and the date of the commit. This changelog is based on [keep a changelog](https://keepachangelog.com)

## [Most Recent Commits](https://github.com/cortex-lab/Rigbox/commits/master) 2.3.0
## [Most Recent Commits](https://github.com/cortex-lab/Rigbox/commits/master) 2.3.1
* patch to readme linking to most up-to-date documentation

## 2.3.0

- patch in alyx-matlab submodule 2019-07-25
- updated Signals performance test `993d906` 2019-07-19
Expand All @@ -19,4 +22,4 @@ Starting after Rigbox 2.2.0, this file contains a curated, chronologically order
- improvements to water expServer calibration function `dd0adb7` 2019-08-14
- updates to signals submodule `f760e5e` 2019-09-03

## [2.2.1](https://github.com/cortex-lab/Rigbox/releases/tag/v2.2.1) (Most Recent Stable Version)
## [2.2.1](https://github.com/cortex-lab/Rigbox/releases/tag/v2.2.1)
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Rigbox is a high-performance, open-source software toolbox for managing behavior

## Getting Started

The following is a brief description of how to install Rigbox on your experimental rig. Detailed, step-by-step information can be found in Rigbox's [ReadTheDocs](https://rigbox.readthedocs.io/en/latest/). Information specific to the steering wheel task can be found on the [CortexLab website](https://www.ucl.ac.uk/cortexlab/tools/wheel).
The following is a brief description of how to install Rigbox on your experimental rig. Detailed, step-by-step information can be found in Rigbox's [documentation](https://github.com/cortex-lab/Rigbox/tree/master/docs). Information specific to the steering wheel task can be found on the [CortexLab website](https://www.ucl.ac.uk/cortexlab/tools/wheel).

### Prerequisites

Expand Down Expand Up @@ -37,9 +37,7 @@ Additionally, Rigbox works with a number of extra submodules (included):
```
git clone --recurse-submodules https://github.com/cortex-lab/Rigbox
```
2. Open MATLAB, make sure Rigbox and all subdirectories are in your path, run:
> addRigboxPaths
and restart MATLAB.
2. Open MATLAB and run `addRigboxPaths.m` then restart the program. *Note*: Do __not__ add all Rigbox folders and subfolders to the paths!
3. Set the correct paths on both computers by following the instructions in the '/docs/setup/paths_config' file.
4. On the stimulus computer, set the hardware configuration by following the instructions in the '/docs/setup/hardware_config' file.
5. To keep the submodules up to date, run the following in the Git Bash terminal (within the Rigbox directory):
Expand Down

0 comments on commit 4ff1a21

Please sign in to comment.