Merge branch 'master' of https://whale.am28.uni-tuebingen.de/git/jgrewe/blipblop

blipblop/ui/help.py

@@ -52,7 +52,7 @@ class HelpBrowser(QWidget):
     def __init__(self, parent=None) -> None:
         super().__init__(parent=parent)
         self.setLayout(QVBoxLayout())
-        # FIXME https://stackoverflow.com/a/43217828  about loading from esource files
+        # FIXME https://stackoverflow.com/a/43217828  about loading from resource files
         doc_url = QUrl.fromLocalFile(cnst.DOCS_ROOT_FILE)
         self._edit = QTextBrowser()
         self._edit.setOpenLinks(True)

docs/auditory_task.md

@@ -0,0 +1,2 @@
+# Auditory reaction times
+

docs/index.md

@@ -1,4 +1,20 @@
 # BlipBlop
 
-Tiny tool for measuring reaction times upon auditory or visual stimuli.
+Tiny tool for measuring reaction times upon auditory or visual stimulation. This tool is open-source. The source code can be found on [GitHub](https://github.com/jgrewe/blipblop). It is published under the MIT open source [license](license.md). 
+Auditory stimuli have been taken from the freedesktop system sounds [freedesktop](https://freedesktop.org)
+
+The main window has three views:
+
+## Visual task
+
+Measure reaction times to a visual stimulus that pops in the center of the screen. ([more](qrc:/docs/visual_task))
+
+## Auditory task
+
+Measure reaction times to a auditory stimulus. ([more](qrc:/docs/auditory_task))
+
+## Results View
+
+A simple tablular view that shows the measured reaction times. The data is given in seconds. Select the data and press (**ctrl+c** or **cmd+c**) to copy the selection to clipboard and paste it into your favorite spreadsheet tool for further analysis.
+
 

docs/license.md

@@ -0,0 +1 @@
+#License

docs/visual_task.md

@@ -0,0 +1,2 @@
+# Visual reaction times
+

resources.qrc

@@ -25,5 +25,8 @@
     </qresource>
     <qresource prefix="docs">
         <file alias="index">docs/index.md</file>
+        <file alias="visual_task">docs/visual_task.md</file>
+        <file alias="auditory_task">docs/auditory_task.md</file>
+        <file alias="license">docs/license.md</file>
     </qresource>
 </RCC>