Updates to README.md

This commit is contained in:
Raymond Jelierse
2012-02-25 21:08:20 +01:00
parent 9149a682b1
commit eda91ff492

View File

@ -1,29 +1,30 @@
Change blindness test Change blindness test
=================== =====================
This is a small web application that can be used to test change blindness. It was developed for This is a small web application that can be used to test change blindness. It was developed for
an assignment in the Visual Communication Design course on the Design for Interaction master at an assignment in the Visual Communication Design course on the Design for Interaction master at
the Delft University of Technology by Raymond Jelierse. the [Delft University of Technology] by [Raymond Jelierse].
Requirements Requirements
----------- ------------
* A webserver with the following packages: * A webserver with the following packages:
* PHP 5.3.x * PHP 5.3.x
* MySQL 5.x * MySQL 5.x
* Twig 1.6 * [Twig] 1.6
* Pairs of images to test with. * Pairs of images to test with.
The filenames should have the following format: `<phase>-(with|without).png`. The filenames should have the following format: `<phase>-(with|without).png`.
You can configure the phases in the `settings.json` file. You can configure the phases in the `settings.json` file.
Set up Set up
----- ------
1. Place the change blindness test somewhere in your webroot. 1. Place the change blindness test somewhere in your webroot.
2. Edit the settings file to your needs. 2. Edit the settings file to your needs.
3. Add the images to the `img` directory. 3. Add the images to the `img` directory.
4. Go to `<your web path>/install/` and follow the on screen instructions. 4. Go to `<your web path>/install/` and follow the on screen instructions.
Acknowledgements Acknowledgements
-------------- ----------------
The change blindness test makes use of the following projects: This project includes code from [Bootstrap].
* [jquery](http://jquery.com/) [Bootstrap]: http://twitter.github.com/bootstrap/
* [bootstrap](http://twitter.github.com/bootstrap/) [Delft University of Technology]: http://home.tudelft.nl/
[Raymond Jelierse]: http://www.raymondjelierse.nl/