Skip to content
This repository has been archived by the owner on Apr 6, 2021. It is now read-only.

Commit

Permalink
Restructured README
Browse files Browse the repository at this point in the history
  • Loading branch information
Curtis Delicata committed Aug 8, 2013
1 parent d8a6fb2 commit 0ec9de6
Showing 1 changed file with 36 additions and 30 deletions.
66 changes: 36 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,66 +16,72 @@ Released under a [BSD license](http://www.modulargaming.com/license), Modular Ga

Download Modular Gaming from Github and install composer dependencies.

$ git clone git@github.com:modulargaming/modulargaming.git
$ cd modulargaming
$ curl -s https://getcomposer.org/installer | php
$ php ./composer.phar install --dev
$ git clone git@github.com:modulargaming/modulargaming.git
$ cd modulargaming

$ curl -s https://getcomposer.org/installer | php
$ php ./composer.phar install --dev

Alternatively you can also use composer create-project to download the project and the dependencies.

$ composer create-project modulargaming/modulargaming modulargaming dev-master
$ composer create-project modulargaming/modulargaming modulargaming dev-master

If you cannot use Composer you can download a packaged copy of Modular Gaming from http://www.sourceforge.net/projects/modulargaming/files/

### Step 2: Configuration of modulargaming


### Step 2: File Permissions

$ chmod 0777 application/{cache,logs}
$ chmod 0777 assets
$ chmod 0777 media

### Step 3: Run the installer

Open `.htaccess` and make the following changes:

* Set the correct RewriteBase

* Set the correct environment, either development or production.
Start the installer and follow the instructions by browsing to the Modular Gaming install with your web browser.

Open `application/bootstrap.php` and make the following changes:
* Once you have completed install, delete the install.php file.

* Set the default directory for your application if it does not automatically work
### Step 4: Admin

* Set the default cookie salt
Register your admin account at /user/register.
Promote your newly created account to admin by using the minion task:

* Set the default [timezone](http://php.net/timezones) for your application
$ php minion User:Promote --username=admin

Open `application/config/auth.php` and make the following changes:
You should now verify that you have admin access by accessing the administration panel at /admin/.

* Set the default hash key
### Step 5: Cron jobs

Open `application/config/email.php` and make the following changes:
$ php ./minion Pet:Decrease
$ php ./minion Item:Restock

* Set the default from address

### Step 3: File Permissions
### Step 6: Configuration of modulargaming

$ chmod 0777 application/{cache,logs}
$ chmod 0777 assets
$ chmod 0777 media
Open `.htaccess` and make the following changes:

### Step 4: Run the installer
* Set the correct environment, either development or production.

Start the installer and follow the instructions by browsing to the Modular Gaming install with your web browser.
Open `application/bootstrap.php` and make the following changes:

### Step 5: Admin
* Set the default directory for your application if it does not automatically work

Register your admin account at /user/register.
Promote your newly created account to admin by using the minion task:
* Set the default cookie salt

$ php minion User:Promote --username=admin
* Set the default [timezone](http://php.net/timezones) for your application

You should now verify that you have admin access by accessing the administration panel at /admin/.
Open `application/config/auth.php` and make the following changes:

### Step 6: Cron jobs
* Set the default hash key

$ php ./minion Pet:Decrease
$ php ./minion Item:Restock
Open `application/config/email.php` and make the following changes:

* Set the default from address

## Testing

Expand Down

0 comments on commit 0ec9de6

Please sign in to comment.