Skip to content

Commit ed16f6a

Browse files
committed
update TOC
1 parent e09faad commit ed16f6a

File tree

1 file changed

+33
-36
lines changed

1 file changed

+33
-36
lines changed

README.md

Lines changed: 33 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[![](https://img.shields.io/badge/Octave-CI-blue?logo=Octave&logoColor=white)](https://github.com/cpp-lln-lab/CPP_PTB/actions)
2-
![](https://github.com/cpp-lln-lab/CPP_PTB/workflows/CI/badge.svg)
2+
![](https://github.com/cpp-lln-lab/CPP_PTB/workflows/CI/badge.svg)
33

44
[![Build Status](https://travis-ci.com/cpp-lln-lab/CPP_PTB.svg?branch=master)](https://travis-ci.com/cpp-lln-lab/CPP_PTB)
55

@@ -11,33 +11,30 @@
1111

1212
# CPP_PTB
1313

14-
<!-- vscode-markdown-toc -->
14+
<!-- TOC -->
15+
1516
- [CPP_PTB](#cpp_ptb)
16-
- [<a name='Requirements'></a>Requirements](#requirements)
17-
- [<a name='Codeguidestyle'></a>Code guidestyle](#code-guidestyle)
18-
- [<a name='Howtoinstall'></a>How to install](#how-to-install)
19-
- [<a name='Downloadwithgit'></a>Download with git](#download-with-git)
20-
- [<a name='Addasasubmodule'></a>Add as a submodule](#add-as-a-submodule)
21-
- [<a name='Exampleforsubmoduleusage'></a>Example for submodule usage](#example-for-submodule-usage)
22-
- [<a name='Directdownload'></a>Direct download](#direct-download)
23-
- [<a name='AddCPP_PTBgloballytothematlabpath'></a>Add CPP_PTB globally to the matlab path](#add-cpp_ptb-globally-to-the-matlab-path)
24-
- [<a name='Documentation'></a>Documentation](#documentation)
25-
- [<a name='Content'></a>Content](#content)
26-
- [<a name='Unittests'></a>Unit tests](#unit-tests)
27-
- [<a name='Contributors'></a>Contributors ✨](#contributors-)
28-
29-
<!-- vscode-markdown-toc-config
30-
numbering=false
31-
autoSave=true
32-
/vscode-markdown-toc-config -->
33-
<!-- /vscode-markdown-toc -->
17+
- [Requirements](#requirements)
18+
- [Code guidestyle](#code-guidestyle)
19+
- [How to install](#how-to-install)
20+
- [Download with git](#download-with-git)
21+
- [Add as a submodule](#add-as-a-submodule)
22+
- [Example for submodule usage](#example-for-submodule-usage)
23+
- [Direct download](#direct-download)
24+
- [Add CPP_PTB globally to the matlab path](#add-cpp_ptb-globally-to-the-matlab-path)
25+
- [Documentation](#documentation)
26+
- [Content](#content)
27+
- [Unit tests](#unit-tests)
28+
- [Contributors ✨](#contributors-)
29+
30+
<!-- /TOC -->
3431

3532

3633
This is the Crossmodal Perception and Plasticity lab (CPP) PsychToolBox (PTB) toolbox.
3734

3835
Those functions are mostly wrappers around some PTB functions to facilitate their use and their reuse (#DontRepeatYourself)
3936

40-
## <a name='Requirements'></a>Requirements
37+
## Requirements
4138

4239
Make sure that the following toolboxes are installed and added to the matlab / octave path.
4340

@@ -52,28 +49,28 @@ For instructions see the following links:
5249
Tested:
5350
- matlab 2015b or octave 4.2.2 and PTB 3.0.14.
5451

55-
## <a name='Codeguidestyle'></a>Code guidestyle
52+
## Code guidestyle
5653

5754
We use the `camelCase` to more easily differentiates our functions from the ones from PTB that use a `PascalCase`.
5855

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

6158
> Regular expressions look scary but are SUPER useful to sort through filenames:
62-
> - A quick [intro to regular expression](https://www.rexegg.com/)
59+
> - A quick [intro to regular expression](https://www.rexegg.com/)
6360
> - And many websites allow you to "design and test" your regular expression:
6461
> - [regexr](https://regexr.com/)
6562
> - [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)
66-
> - ...
63+
> - ...
6764
68-
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).
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).
6966

70-
We use the [MISS_HIT linter](https://florianschanda.github.io/miss_hit/style_checker.html) to automatically fix some linting issues.
67+
We use the [MISS_HIT linter](https://florianschanda.github.io/miss_hit/style_checker.html) to automatically fix some linting issues.
7168

7269
The code style and quality is also checked during the [continuous integration](./.travis.yml).
7370

74-
## <a name='Howtoinstall'></a>How to install
71+
## How to install
7572

76-
### <a name='Downloadwithgit'></a>Download with git
73+
### Download with git
7774

7875
``` bash
7976
cd fullpath_to_directory_where_to_install
@@ -95,7 +92,7 @@ To work with a specific version, create a branch at a specific version tag numbe
9592
git checkout -b version1 v1.0.0
9693
```
9794

98-
### <a name='Addasasubmodule'></a>Add as a submodule
95+
### Add as a submodule
9996

10097
Add it as a submodule in the repo you are working on.
10198

@@ -113,7 +110,7 @@ git submodule update --remote --merge
113110

114111
Remember that updates to submodules need to be committed as well.
115112

116-
#### <a name='Exampleforsubmoduleusage'></a>Example for submodule usage
113+
#### Example for submodule usage
117114

118115
So say you want to clone a repo that has some nested submodules, then you would type this to get the content of all the submodules at once (here with my experiment repo):
119116
``` bash
@@ -137,7 +134,7 @@ git submodule foreach --recursive 'git submodule init'
137134
git submodule foreach --recursive 'git submodule update'
138135
```
139136

140-
### <a name='Directdownload'></a>Direct download
137+
### Direct download
141138

142139
Download the code. Unzip. And add to the matlab path.
143140

@@ -149,7 +146,7 @@ Or take the latest commit (NOT RECOMMENDED):
149146

150147
https://github.com/cpp-lln-lab/CPP_PTB/archive/master.zip
151148

152-
### <a name='AddCPP_PTBgloballytothematlabpath'></a>Add CPP_PTB globally to the matlab path
149+
### Add CPP_PTB globally to the matlab path
153150

154151
This is NOT RECOMMENDED as this might create conflicts if you different versions of CPP_PTB as sub-modules.
155152

@@ -158,11 +155,11 @@ This is NOT RECOMMENDED as this might create conflicts if you different versions
158155
matlab -nojvm -nosplash -r "addpath(genpath(fullfile(pwd, 'src'))); savepath(); path(); exit();"
159156
```
160157

161-
## <a name='Documentation'></a>Documentation
158+
## Documentation
162159

163160
All the documentation is accessible [here](./docs/00_index.md).
164161

165-
## <a name='Content'></a>Content
162+
## Content
166163

167164
```bash
168165
├── demos # quick demo of how to use some functions
@@ -180,11 +177,11 @@ All the documentation is accessible [here](./docs/00_index.md).
180177
└── tests # all the tests that that can be run by github actions
181178
```
182179

183-
## <a name='Unittests'></a>Unit tests
180+
## Unit tests
184181

185182
Unit tests are run with the mox unit toolbox and automated with github action on Octave.
186183

187-
## <a name='Contributors'></a>Contributors ✨
184+
## Contributors ✨
188185

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

0 commit comments

Comments
 (0)