Read Me

/**
 * Madeam :  Rapid Development MVC Framework <http://www.madeam.com/>
 * Copyright (c)	2006, Joshua Davey
 *								24 Ridley Gardens, Toronto, Ontario, Canada
 *
 * Licensed under The MIT License
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright		Copyright (c) 2006, Joshua Davey
 * @link				http://www.madeam.com
 * @package			madeam
 * @version			0.0.1
 * @license			http://www.opensource.org/licenses/mit-license.php The MIT License
 * @author      Joshua Davey
 */

/* Installation (Root Directory)
-------------------------------------------------------- */

1. Unzip your folders into the root directory
2. Edit config/setup.php (Select your development environment - Defaults to 'development')
3. Edit environment/[selected environemnt]/database.php
4. Visit http://yourwebsite.com/public/ (You will see an error because you haven't setup any controllers or views)

/* Adding A Controller
-------------------------------------------------------- */

1. Open the directory application/controllers/
2. Create a new file. Example: 'index_controller.php'
3. Define your controller's class:

<?php
class indexController extends appController {

}
?>

4. Visit http://yourwebsite.com/public/index (You will see an error because you need to add an action to your controller)

/* Adding An Action To A Controller
-------------------------------------------------------- */

1. Open one of your controllers. Example: 'application/controllers/index_controller.php'
2. Add a new method to your controller's class. The method should be named after your action. Example: 'index'

<?php
class indexController extends appController {
  public function index() {

  }
}
?>

3. Visit http://yourwebsite.com/public/index/index (You will see an error because you haven't added a view for your action)

/* Adding An Action's View
-------------------------------------------------------- */

1. Open the directory application/views/[controller name]/ where the name of the controller is the controller the action is in
2. Create a new file. Example: index.html where 'index' is the name of the action
3. Visit http://yourwebsite.com/public/index/index


Note: You do not need to add a controller or action to view a static page.
For example if your http://yourwebsite.com/public/index/index is static then you just need to make a directory
in your views directory called 'index' and create an html file in the directory you just created called 'index.html'

Example: application/views/index/index.html


/* Creating A Model
-------------------------------------------------------- */

1. Open the directory application/models
2. Create a new file. Example: article_model.php (All model names must be singular)
3. Define your model's class:

<?php
class articleModel extends activeRecord {

}
?>

Note:
If the model represents a database record it's class should extend "activeRecord".
If the model represents a file directory it's class should extend "activeFile".