Skip to content

Commit 258ebc2

Browse files
committed
reorganize README sections
1 parent ed16f6a commit 258ebc2

File tree

1 file changed

+36
-36
lines changed

1 file changed

+36
-36
lines changed

README.md

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,15 @@
1515

1616
- [CPP_PTB](#cpp_ptb)
1717
- [Requirements](#requirements)
18-
- [Code guidestyle](#code-guidestyle)
18+
- [Documentation](#documentation)
19+
- [Content](#content)
1920
- [How to install](#how-to-install)
2021
- [Download with git](#download-with-git)
2122
- [Add as a submodule](#add-as-a-submodule)
2223
- [Example for submodule usage](#example-for-submodule-usage)
2324
- [Direct download](#direct-download)
2425
- [Add CPP_PTB globally to the matlab path](#add-cpp_ptb-globally-to-the-matlab-path)
25-
- [Documentation](#documentation)
26-
- [Content](#content)
26+
- [Code style guide](#code-style-guide)
2727
- [Unit tests](#unit-tests)
2828
- [Contributors ✨](#contributors-)
2929

@@ -49,24 +49,27 @@ For instructions see the following links:
4949
Tested:
5050
- matlab 2015b or octave 4.2.2 and PTB 3.0.14.
5151

52-
## Code guidestyle
53-
54-
We use the `camelCase` to more easily differentiates our functions from the ones from PTB that use a `PascalCase`.
55-
56-
In practice, we use the following regular expression for function names: `[a-z]+(([A-Z]|[0-9]){1}[a-z]+)*`.
57-
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-
> - ...
52+
## Documentation
6453

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).
54+
All the documentation is accessible [here](./docs/00_index.md).
6655

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

69-
The code style and quality is also checked during the [continuous integration](./.travis.yml).
58+
```bash
59+
├── demos # quick demo of how to use some functions
60+
├── dev # templates for experiment (will be moved out soon)
61+
├── docs # documentation
62+
├── manualTests # all the tests that cannot be automated (yet)
63+
├── src # actual code of the CPP_PTB
64+
│ ├── aperture # function related to create apertur (circle, wedge, bar...)
65+
│ ├── dot # functions to simplify the creations of RDK
66+
│ ├── errors # all error functions
67+
│ ├── fixation # to create fixation cross, dots
68+
│ ├── keyboard # to collect responses, abort experiment...
69+
│ ├── randomization # functions to help with trial randomization
70+
│ └── utils # set of general functions
71+
└── tests # all the tests that that can be run by github actions
72+
```
7073

7174
## How to install
7275

@@ -155,27 +158,24 @@ 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-
## Documentation
161+
## Code style guide
159162

160-
All the documentation is accessible [here](./docs/00_index.md).
163+
We use the `camelCase` to more easily differentiates our functions from the ones from PTB that use a `PascalCase`.
161164

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

164-
```bash
165-
├── demos # quick demo of how to use some functions
166-
├── dev # templates for experiment (will be moved out soon)
167-
├── docs # documentation
168-
├── manualTests # all the tests that cannot be automated (yet)
169-
├── src # actual code of the CPP_PTB
170-
│ ├── aperture # function related to create apertur (circle, wedge, bar...)
171-
│ ├── dot # functions to simplify the creations of RDK
172-
│ ├── errors # all error functions
173-
│ ├── fixation # to create fixation cross, dots
174-
│ ├── keyboard # to collect responses, abort experiment...
175-
│ ├── randomization # functions to help with trial randomization
176-
│ └── utils # set of general functions
177-
└── tests # all the tests that that can be run by github actions
178-
```
167+
> Regular expressions look scary but are SUPER useful to sort through filenames:
168+
> - A quick [intro to regular expression](https://www.rexegg.com/)
169+
> - And many websites allow you to "design and test" your regular expression:
170+
> - [regexr](https://regexr.com/)
171+
> - [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)
172+
> - ...
173+
174+
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).
175+
176+
We use the [MISS_HIT linter](https://florianschanda.github.io/miss_hit/style_checker.html) to automatically fix some linting issues.
177+
178+
The code style and quality is also checked during the [continuous integration](./.travis.yml).
179179

180180
## Unit tests
181181

0 commit comments

Comments
 (0)