add a bit of doc

Author: Remi-Gau

.travis.yml

@@ -2,7 +2,7 @@
 # This will only work on your repo if you have an account on travis and you
 # have set it up to run continuous integration on this this repo
 
-# Linux distribution
+# Linux distribution (bionic beaver)
 dist: bionic
 
 # Language and version

README.md

@@ -57,7 +57,7 @@ We use the following regular expression for function names: `[a-z]+(([A-Z]|[0-9]
 
 We keep the McCabe complexity as reported by the [check_my_code function](https://github.com/Remi-Gau/check_my_code) below 15.
 
-We use the [MISS_HIT linter](https://florianschanda.github.io/miss_hit/style_checker.html) to automatically fix some linting issues.
+We use the [MISS_HIT linter](https://florianschanda.github.io/miss_hit/style_checker.html) to automatically fix some linting issues. The code style and quality is also checked during the continuous integration.
 
 ##  3. <a name='Howtoinstall'></a>How to install
 
@@ -170,6 +170,10 @@ Using empty vectors (ie `[]`) or a negative value for those means that you will
 
 ##  5. <a name='Structure'></a>Structure
 
+The `cfg` structure is where most of the information about your experiment will be defined.
+
+Below we try to outline what it contains.
+
 ```matlab
 
 cfg.testingDevice = 'pc';

docs/functions_description.md

@@ -32,7 +32,7 @@
 This will initialize PsychToolBox
 
 -   screen
--   the windon opened takes the whole screen by default
+-   the window opened takes the whole screen by default
 -   set in debug mode with window transparency if necessary
 -   can skip synch test if you ask for it (nicely)
 -   gets the flip interval

miss_hit.cfg

@@ -1,7 +1,9 @@
+# styly guide (https://florianschanda.github.io/miss_hit/style_checker.html)
 line_length: 100
 regex_function_name: "[a-z]+(([A-Z]){1}[A-Za-z]+)*"
 suppress_rule: "copyright_notice"
 
+# metrics limit for the code quality (https://florianschanda.github.io/miss_hit/metrics.html)
 metric "cnest": limit 4
 metric "file_length": limit 500
 metric "cyc": limit 15