Skip to content

Commit 1b595d9

Browse files
committed
update README
1 parent 3471667 commit 1b595d9

File tree

1 file changed

+22
-5
lines changed

1 file changed

+22
-5
lines changed

README.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ For instructions see the following links:
4444
|----------------------------------------------------------|--------------|
4545
| [PsychToolBox](http://psychtoolbox.org/) | >=3.0.14 |
4646
| [Matlab](https://www.mathworks.com/products/matlab.html) | >=2015b |
47-
| or [octave](https://www.gnu.org/software/octave/) | 4.? |
47+
| or [Octave](https://www.gnu.org/software/octave/) | 4.? |
4848

4949
Tested:
5050
- matlab 2015b or octave 4.2.2 and PTB 3.0.14.
@@ -55,7 +55,14 @@ We use the `camelCase` to more easily differentiates our functions from the ones
5555

5656
In practice, we use the following regular expression for function names: `[a-z]+(([A-Z]|[0-9]){1}[a-z]+)*`.
5757

58-
We keep the McCabe complexity as reported by the [check_my_code function](https://github.com/Remi-Gau/check_my_code) below 15 or the [MISS_HIT code checker](https://florianschanda.github.io/miss_hit)
58+
> Regular expressions look scary but are SUPER useful to sort through filenames:
59+
> - A quick [intro to regular expression](https://www.rexegg.com/)
60+
> - And many websites allow you to "design and test" your regular expression:
61+
> - [regexr](https://regexr.com/)
62+
> - [regexper](https://regexper.com/#%5Ba-z%5D%2B%28%28%5BA-Z%5D%7C%5B0-9%5D%29%7B1%7D%5Ba-z%5D%2B%29)
63+
> - ...
64+
65+
We keep the McCabe complexity as reported by the [check_my_code function](https://github.com/Remi-Gau/check_my_code) below 15 or the [MISS_HIT code checker](https://florianschanda.github.io/miss_hit). A couple of code quality metrics are also checked automatically by MISS_HIT (avoiding functions with too many nested `if` blocks).
5966

6067
We use the [MISS_HIT linter](https://florianschanda.github.io/miss_hit/style_checker.html) to automatically fix some linting issues.
6168

@@ -71,11 +78,9 @@ cd fullpath_to_directory_where_to_install
7178
git clone https://github.com/cpp-lln-lab/CPP_PTB.git
7279
# move into the folder you have just created
7380
cd CPP_PTB
74-
# add the src folder to the matlab path and save the path
75-
matlab -nojvm -nosplash -r "addpath(fullfile(pwd)); savepath ();"
7681
```
7782

78-
Then get the latest commit:
83+
Then get the latest commit to stay up to date:
7984
```bash
8085
# from the directory where you downloaded the code
8186
git pull origin master
@@ -145,6 +150,14 @@ Or take the latest commit (NOT RECOMMENDED):
145150

146151
https://github.com/cpp-lln-lab/CPP_PTB/archive/master.zip
147152

153+
### Add CPP_PTB globally to the matlab path
154+
155+
This is NOT RECOMMENDED as this might create conflicts if you different versions of CPP_PTB as sub-modules.
156+
157+
```bash
158+
# from within the CPP_PTB folder
159+
matlab -nojvm -nosplash -r "addpath(genpath(fullfile(pwd, 'src'))); savepath(); path(); exit();"
160+
```
148161

149162
## 4. <a name='Documentation'></a>Documentation
150163

@@ -168,6 +181,10 @@ All the documentation is accessible [here](./docs/00_index.md).
168181
└── tests # all the tests that that can be run by github actions
169182
```
170183

184+
## Unit tests
185+
186+
Unit tests are run with the mox unit toolbox and automated with github action on Octave.
187+
171188
## 6. <a name='Contributors'></a>Contributors ✨
172189

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

0 commit comments

Comments
 (0)