/**
* This file offers a short overview over the IrisMVC v2.0 RC1 framework
*--------------------------------------------------------------------------------------------------------------
* @desc    : IrisMVC is a very lightweight PHP framework (~80Kb) built for Rapid Application Development (RAD).
* @version : 2.0
* @status  : Release Candidate
* @autor   : Costin Trifan
* @website : http://irismvc.net
* @forums  : http://forums.irismvc.net
* @license : Microsoft Public License (Ms-PL)  http://irismvc.net/license.txt
*--------------------------------------------------------------------------------------------------------------
*/

(1). Requirements:
===================================
     :: Apache 2+ (mod rewrite enabled)
     :: PHP 5.2+
     :: MySQL 5+


(2). Installation:
===================================
     :: Extract the content of the irismvc2.0-rc1 archive into your local server's root.

     :: Open and edit the site.config.ini file to reflect your own settings.


(3). Info:
===================================

    :: Configuration files
        :: site.config.ini    This file stores your application's global settings. 
        :: site.functions.php You can use this file to store your globally available functions. 
        :: site.settings      Use this file to store all new your website's settings, setup a database connection, instantiate
                              particular classes, change themes, languages etc..


    :: Libraries directory (./libs)
        This directory should hold all 3rd party libraries, classes or plugins and just like the code directory,
		the path to this directory is automatically added to the global include path.
		The only difference is that you cannot add your php files directly into this folder.
        They should reside in their own directories.
        Example: If you have a pagination class you want to use in your website and it's only one file, you
        should put that class inside a directory and then drop it into the libraries directory.
        The same restrictions defined for the code directory include file applies here too.

    :: Code directory (site/code)
        The path to the code directory is automatically added to the global include path; that means
        that you will be able to use any classes from the files added in that directory without using
        the require or include functions. This feature will only be available if the name of the class
        inside of the file is the same as the name of the file. You will have specifically include that file if:
            - the name of the class inside doesn't match the name of the file
            - there is more than one class defined in that file
            - there are only functions in that file

    :: Themes directory (site/themes)
        All your themes should be added in their own folder. As a best practice, all your themes should have
        the same inner structure, and that is:
            - css       this directory should be used to store all theme's stylesheet files
            - images    this directory should be used to store all theme's images
            - js        this directory should be used to store the theme's javascript scripts
        !! By having your themes organized like this it will be much more easier to switch between themes and masterpages.

    :: Themes shared directory (site/themes/_shared)
        This subdirectory will hold all files that you want to share across your themes, so you will not duplicate
        them in all your themes. This directory is prefixed with an underscore so you can differentiate it from other
        themes in case you want to have a page where you can display all available themes in your website.
        As a best practice:
            - add all stylesheet and javascript file directly into this subdirectory
            - add all images into the images subdirectory

    :: Views directory (site/views)
        This directory holds all your view files in specific directories. You should add all public accessible files
        into the frontend directory, while the pages that require an authenticated/authorized user can be added into
        the backend directory.
        Like the themes shared directory, the views directory has a _shared folder too, that you can use to store
        all code snippets, master pages or error pages that will not be dependent of whether you are in the backend
        or frontend side of your website.
        The backend and the frontend directories have this inner structure:
            - error-pages  : this directory will hold all error pages defined for each section of the website
            - master-pages : this directory will hold all master pages defined for each section of the website
            - slots        : this directory will hold all template files, code snippets, etc... for each section of the website

/*----------------------------------------------------------------------------------------------------------------------------------*/