Skip to content

Commit

Permalink
Fix README formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
Simon Ho committed Apr 16, 2017
1 parent c4341a1 commit beee393
Show file tree
Hide file tree
Showing 6 changed files with 17 additions and 12 deletions.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#Cognitive Battery
# Cognitive Battery

<img align="left" src="images/icon.png">

Expand Down Expand Up @@ -28,7 +28,8 @@ but I will be refactoring much of the code over time to clean things up.
This will include things like code reduction, better handling of different
screen resolutions, and improved logic.

##Requirements
## Requirements

You will need to have the following dependencies installed to run the battery,
most of which are just Python modules:

Expand All @@ -55,7 +56,8 @@ most of which are just Python modules:
[here](http://www.lfd.uci.edu/~gohlke/pythonlibs/#pygame) and install
using pip (`pip install <filename>`)

##Usage
## Usage

Using the battery is as simple as running the `run_battery.py` file. This
can either be done using the command line (navigate to the directory and type
`python run_battery.py`), or running it from IDLE.
Expand All @@ -71,7 +73,8 @@ Alternatively, you can set a random order using the checkbox.
The task results are saved in the `/data` directory. Each participant's data
is saved as an Excel file, where each task is saved to a separate sheet.

##Tasks
## Tasks

Currently implemented tasks:

* **Attention Network Test (ANT)**
Expand All @@ -94,7 +97,8 @@ Currently implemented tasks:
- Based on the original version by
[Robertson et al. (1997)](http://www.sciencedirect.com/science/article/pii/S0028393297000158)

##Contribution
## Contribution

**Note**: I intend to majorly streamline this process in future releases,
hopefully automating the importing/running/saving of tasks.

Expand Down Expand Up @@ -135,7 +139,8 @@ method
Consider making a pull request and please include a journal reference for any
new tasks you add.

##TODO
## TODO

In no particular order...

**General**
Expand All @@ -161,6 +166,6 @@ for statistics
- Likely to be CSV, but open to suggestions
- Add more tasks...

##Changelog
## Changelog

You can view the change log/release notes [here](CHANGELOG.md)
2 changes: 1 addition & 1 deletion designer/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#Designer Files
# Designer Files

The `/ui` directory contains `.ui` files used by QT Designer to create
the various windows and dialogs of the application. Edit those in QT Designer
Expand Down
2 changes: 1 addition & 1 deletion interface/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#Interface Files
# Interface Files

This directory contains class definitions for the different windows and dialog
boxes. These are imported by the main script as modules and used to
Expand Down
2 changes: 1 addition & 1 deletion tasks/images/MRT/README.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
#Mental Rotation Task Images
# Mental Rotation Task Images
2 changes: 1 addition & 1 deletion tasks/images/Ravens/README.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
#Raven's Matrices Images
# Raven's Matrices Images
2 changes: 1 addition & 1 deletion tasks/images/Ravens/practice/README.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
#Raven's Matrices Practice Images
# Raven's Matrices Practice Images

0 comments on commit beee393

Please sign in to comment.