diff --git a/README b/README deleted file mode 100644 index e69de29..0000000 diff --git a/README.md b/README.md new file mode 100644 index 0000000..f17cb24 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +ScattPort - Webinterface for light scattering simulators +======================================================== + +Setup +----- + +To install a local instance of this webinterface, the following software is required: + +* Webserver (mod_rewrite is a plus, but not required. see application/config/config.php) +* PHP 5 +* MySQL + +Simply import mysql_scheme.sql into your database, set the connection data inside application/config/database.php. + +Copy config/database.sample.php to config/database.php and adjust the values. +Same thing goes for config/config.sample.php and .htaccess.sample (if you want mod_rewrite-support). + + +License +------- + +This application is published under the MIT License. See COPYING. + +This application uses the following third-party software: + +* CodeIgniter by Ellislab, http://codeigniter.com +* jQuery, http://jquery.com/ +* Fugue Icons, http://p.yusukekamiyamane.com/