Update setup instructions in README.md

This commit is contained in:
Karsten Heiken
2011-12-04 16:13:06 +01:00
parent ef3b76a28c
commit 51310e9edd

View File

@@ -4,18 +4,33 @@ ScattPort - Webinterface for light scattering simulators
Setup 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) $ git clone https://github.com/krstn/scattport.git
* PHP 5 $ cd scattport
* MySQL
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. $ mysqladmin -uroot create $DATABASE
Same thing goes for config/config.sample.php and .htaccess.sample (if you want mod_rewrite-support). $ 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 License