diff --git a/README.md b/README.md index 2d36ef6..44f7882 100644 --- a/README.md +++ b/README.md @@ -4,18 +4,33 @@ ScattPort - Webinterface for light scattering simulators Setup ----- -To install a local instance of this webinterface, the following software is required: +First, get a clone of the current release: -* Webserver (mod_rewrite is a plus, but not required. see application/config/config.php) -* PHP 5 -* MySQL + $ git clone https://github.com/krstn/scattport.git + $ cd scattport -Simply import mysql_scheme.sql into your database, set the connection data inside application/config/database.php. +Now, create the database schema. There is a sample .sql file included for use with MySQL: -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). + $ mysqladmin -uroot create $DATABASE + $ mysql -uroot $DATABASE < mysql_schema.sql -Don't forget to make the upload directory writable by the web server. +Replace $DATABASE with whatever suits your needs. + +There are two configurations files included that you need to modify: + +* `config.php` - changes required in line 17 and 29 +* `database.php` - lines 44 to 48 need to be adjusted to suit your environment + +Copy the samples and edit them accordingly: + + $ cp application/config/config.sample.php application/config/config.php + $ cp application/config/database.sample.php application/config/database.php + $ vim application/config/config.php + $ vim application/config/database.php + +It is important to copy these files rather than moving them. If you move them, updates (`git pull`) would get nasty. + +The file `application/config/scattport.php` contains some settings for the different simulators you want to integrate. The file is fully documented, so you should be fine. License