Skip to content

Commit e09faad

Browse files
committed
Update TOC
1 parent 8651721 commit e09faad

File tree

1 file changed

+26
-23
lines changed

1 file changed

+26
-23
lines changed

README.md

Lines changed: 26 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,22 @@
1212
# CPP_PTB
1313

1414
<!-- vscode-markdown-toc -->
15-
* 1. [Requirements](#Requirements)
16-
* 2. [Code guidestyle](#Codeguidestyle)
17-
* 3. [How to install](#Howtoinstall)
18-
* 3.1. [Download with git](#Downloadwithgit)
19-
* 3.2. [Add as a submodule](#Addasasubmodule)
20-
* 3.2.1. [Example for submodule usage](#Exampleforsubmoduleusage)
21-
* 3.3. [Direct download](#Directdownload)
22-
* 4. [Documentation](#Documentation)
23-
* 5. [Content](#Content)
24-
* 6. [Contributors ✨](#Contributors)
15+
- [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-)
2528

2629
<!-- vscode-markdown-toc-config
27-
numbering=true
30+
numbering=false
2831
autoSave=true
2932
/vscode-markdown-toc-config -->
3033
<!-- /vscode-markdown-toc -->
@@ -34,7 +37,7 @@ This is the Crossmodal Perception and Plasticity lab (CPP) PsychToolBox (PTB) to
3437

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

37-
## 1. <a name='Requirements'></a>Requirements
40+
## <a name='Requirements'></a>Requirements
3841

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

@@ -49,7 +52,7 @@ For instructions see the following links:
4952
Tested:
5053
- matlab 2015b or octave 4.2.2 and PTB 3.0.14.
5154

52-
## 2. <a name='Codeguidestyle'></a>Code guidestyle
55+
## <a name='Codeguidestyle'></a>Code guidestyle
5356

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

@@ -68,9 +71,9 @@ We use the [MISS_HIT linter](https://florianschanda.github.io/miss_hit/style_che
6871

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

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

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

7578
``` bash
7679
cd fullpath_to_directory_where_to_install
@@ -92,7 +95,7 @@ To work with a specific version, create a branch at a specific version tag numbe
9295
git checkout -b version1 v1.0.0
9396
```
9497

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

97100
Add it as a submodule in the repo you are working on.
98101

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

111114
Remember that updates to submodules need to be committed as well.
112115

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

115118
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):
116119
``` bash
@@ -134,7 +137,7 @@ git submodule foreach --recursive 'git submodule init'
134137
git submodule foreach --recursive 'git submodule update'
135138
```
136139

137-
### 3.3. <a name='Directdownload'></a>Direct download
140+
### <a name='Directdownload'></a>Direct download
138141

139142
Download the code. Unzip. And add to the matlab path.
140143

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

147150
https://github.com/cpp-lln-lab/CPP_PTB/archive/master.zip
148151

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

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

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

158-
## 4. <a name='Documentation'></a>Documentation
161+
## <a name='Documentation'></a>Documentation
159162

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

162-
## 5. <a name='Content'></a>Content
165+
## <a name='Content'></a>Content
163166

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

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

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

184-
## 6. <a name='Contributors'></a>Contributors ✨
187+
## <a name='Contributors'></a>Contributors ✨
185188

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

0 commit comments

Comments
 (0)