Skip to content

Commit 82f1056

Browse files
committed
update README
1 parent e8729e1 commit 82f1056

File tree

1 file changed

+13
-59
lines changed

1 file changed

+13
-59
lines changed

README.md

Lines changed: 13 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,17 @@
1-
<!-- lint disable -->
2-
3-
**Documentation**
4-
51
[![Documentation Status: stable](https://readthedocs.org/projects/cpp-ptb/badge/?version=stable)](https://cpp-ptb.readthedocs.io/en/stable/?badge=stable)
6-
7-
**Cite it**
8-
92
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4007672.svg)](https://doi.org/10.5281/zenodo.4007672)
10-
11-
**Unit tests and coverage**
12-
133
[![](https://img.shields.io/badge/Octave-CI-blue?logo=Octave&logoColor=white)](https://github.com/cpp-lln-lab/CPP_PTB/actions)
144
![](https://github.com/cpp-lln-lab/CPP_PTB/workflows/CI/badge.svg)
15-
165
[![codecov](https://codecov.io/gh/cpp-lln-lab/CPP_PTB/branch/master/graph/badge.svg)](https://codecov.io/gh/cpp-lln-lab/CPP_PTB)
17-
18-
**Contributors**
19-
20-
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
216
[![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](#contributors-)
22-
<!-- ALL-CONTRIBUTORS-BADGE:END -->
237

248
# CPP_PTB
259

26-
<!-- TOC -->
27-
28-
- [CPP_PTB](#cpp_ptb)
29-
- [Documentation](#documentation)
30-
- [Content](#content)
31-
- [Code style guide](#code-style-guide)
32-
- [Unit tests](#unit-tests)
33-
- [Contributors ✨](#contributors-)
34-
35-
<!-- /TOC -->
36-
37-
<!-- lint enable -->
10+
- [CPP_PTB](#cpp_ptb)
11+
- [Documentation](#documentation)
12+
- [Content](#content)
13+
- [Contributing](#contributing)
14+
- [Contributors ✨](#contributors-)
3815

3916
This is the Crossmodal Perception and Plasticity lab (CPP) PsychToolBox (PTB)
4017
toolbox.
@@ -64,39 +41,16 @@ All the documentation and installtion information is accessible
6441
└── tests # all the tests that that can be run by github actions
6542
```
6643

67-
## Code style guide
68-
69-
We use the `camelCase` to more easily differentiates our functions from the ones
70-
from PTB that use a `PascalCase`.
71-
72-
In practice, we use the following regular expression for function names:
73-
`[a-z]+(([A-Z]|[0-9]){1}[a-z]+)*`.
74-
75-
> Regular expressions look scary but are SUPER useful to sort through filenames:
76-
>
77-
> - A quick [intro to regular expression](https://www.rexegg.com/)
78-
>
79-
> - And many websites allow you to "design and test" your regular expression:
80-
> - [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)
81-
> - ...
82-
83-
We keep the McCabe complexity below 15 as reported by the
84-
[check_my_code function](https://github.com/Remi-Gau/check_my_code) or the
85-
[MISS_HIT code checker](https://florianschanda.github.io/miss_hit). A couple of
86-
code quality metrics are also checked automatically by MISS_HIT (avoiding
87-
functions with too many nested `if` blocks).
88-
89-
We use the
90-
[MISS_HIT linter](https://florianschanda.github.io/miss_hit/style_checker.html)
91-
to automatically fix some linting issues.
92-
93-
The code style and quality is also checked during the
94-
[continuous integration](.github/workflows/miss_hit.yml).
44+
## Contributing
9545

96-
## Unit tests
46+
Feel free to open issues to report a bug and ask for improvements.
9747

98-
Unit tests are run with the mox unit toolbox and automated with github action on
99-
Octave.
48+
If you want to contribute, have a look at our
49+
[contributing guidelines](https://github.com/cpp-lln-lab/.github/blob/main/CONTRIBUTING.md)
50+
that are meant to guide you and help you get started. If something is not clear
51+
or you get stuck: it is more likely we did not do good enough a job at
52+
explaining things. So do not hesitate to open an issue, just to ask for
53+
clarification.
10054

10155
## Contributors ✨
10256

0 commit comments

Comments
 (0)