diff --git a/blipblop_darwin.spec b/blipblop_darwin.spec index cbfb7ef..9194b4c 100644 --- a/blipblop_darwin.spec +++ b/blipblop_darwin.spec @@ -10,6 +10,9 @@ a = Analysis(['blipblop_main.py'], ('docs/visual_task.md', "docs"), ('docs/auditory_task.md', "docs"), ('docs/license.md', "docs"), + ('docs/tasks.md', "docs"), + ('docs/images/blipblop_main.png', "docs/images"), + ('docs/images/blipblop_logo.png', "docs/images"), ('sounds/bell.wav', "sounds"), ('sounds/complete.wav', "sounds"), ('sounds/message.wav', "sounds"), diff --git a/blipblop_linux.spec b/blipblop_linux.spec index 36cd04e..7bad729 100644 --- a/blipblop_linux.spec +++ b/blipblop_linux.spec @@ -10,6 +10,10 @@ a = Analysis(['blipblop_main.py'], ('docs/visual_task.md', "docs"), ('docs/auditory_task.md', "docs"), ('docs/license.md', "docs"), + ('docs/results.md', "docs"), + ('docs/tasks.md', "docs"), + ('docs/images/blipblop_main.png', "docs/images"), + ('docs/images/blipblop_logo.png', "docs/images"), ('sounds/bell.wav', "sounds"), ('sounds/complete.wav', "sounds"), ('sounds/message.wav', "sounds"), diff --git a/docs/images/blipblop_logo.png b/docs/images/blipblop_logo.png new file mode 100644 index 0000000..9d38447 Binary files /dev/null and b/docs/images/blipblop_logo.png differ diff --git a/docs/images/blipblop_main.png b/docs/images/blipblop_main.png new file mode 100644 index 0000000..c442c1f Binary files /dev/null and b/docs/images/blipblop_main.png differ diff --git a/docs/index.md b/docs/index.md index 7e92787..f53d5e8 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,19 +1,26 @@ + # BlipBlop -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). +![blip blop](images/blipblop_logo.png) + +BlipBlop is a 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 +## Main Window + +![main screen](images/blipblop_main.png) + + +### Visual task -Measure reaction times to a visual stimulus that pops in the center of the screen. ([more](qrc:/docs/visual_task)) +Measure reaction times to a visual stimulus that pops in the center of the screen. ([more](visual_task.md)) -## Auditory task +### Auditory task -Measure reaction times to a auditory stimulus. ([more](qrc:/docs/auditory_task)) +Measure reaction times to a auditory stimulus. ([more](auditory_task.md)) -## Results View +### 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 index 96ead31..4c57d76 100644 --- a/docs/license.md +++ b/docs/license.md @@ -1 +1,9 @@ -#License \ No newline at end of file +# License + +Copyright 2021, Jan Grewe + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/docs/results.md b/docs/results.md new file mode 100644 index 0000000..e43f7df --- /dev/null +++ b/docs/results.md @@ -0,0 +1 @@ +# Results view \ No newline at end of file diff --git a/docs/tasks.md b/docs/tasks.md new file mode 100644 index 0000000..e69de29