diff --git a/blipblop/ui/help.py b/blipblop/ui/help.py index 2f482fa..362799d 100644 --- a/blipblop/ui/help.py +++ b/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) diff --git a/docs/auditory_task.md b/docs/auditory_task.md new file mode 100644 index 0000000..f9c53e2 --- /dev/null +++ b/docs/auditory_task.md @@ -0,0 +1,2 @@ +# Auditory reaction times + diff --git a/docs/index.md b/docs/index.md index 8bb5014..7e92787 100644 --- a/docs/index.md +++ b/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. + diff --git a/docs/license.md b/docs/license.md new file mode 100644 index 0000000..96ead31 --- /dev/null +++ b/docs/license.md @@ -0,0 +1 @@ +#License \ No newline at end of file diff --git a/docs/visual_task.md b/docs/visual_task.md new file mode 100644 index 0000000..5c7035c --- /dev/null +++ b/docs/visual_task.md @@ -0,0 +1,2 @@ +# Visual reaction times + diff --git a/resources.qrc b/resources.qrc index b2c92b3..24ddf5d 100644 --- a/resources.qrc +++ b/resources.qrc @@ -25,5 +25,8 @@ docs/index.md + docs/visual_task.md + docs/auditory_task.md + docs/license.md \ No newline at end of file