/**
* readme.txt
* ------------------------------------------------------------
* Package:   MyGosuClan
* Version:   1.04
* License:   GNU GPL
* Author:    cagrET (Cezary Tomczak)
* Email:     cagret at gmail.com
* Homepage:  http://www.gosu.pl/mgc/
* ------------------------------------------------------------
*/

# Last updated: 2003-04-21

1. Requirements
2. Copyrights
3. Install
   3.1 Files
   3.2 Automatic install
   3.3 Informations
4. Help
   4.1 HELP ME !
   4.2 bugs
   4.3 chmod
   4.4 database
   4.5 Safe-mode
5. Config
6. Templates
7. About MGC system
   7.1 Users auth/rights
   7.2 Section IP ban
   7.3 _private dir
   7.4 User posts

# START

1. Requirements
   
   PHP 4 (or higher)
   MySQL 3.23 (or higher)

   Notice:
   - tested on: PHP 4.4.4, PHP 5.3.1, Mysql 5.x

2. Copyrights
   
   Please, put a link to the project's homepage on your site:

   [code]
   Powered by <a href="http://www.gosu.pl/mgc/">MyGosuCLan</a> v1.04
   [/code]

3. Install
   3.1 Files (SECURITY)
       
       Change attributes for the following directories/files, so they are writable:

       init/db.php
       _private/sessiondata/
       _private/templates_c/
       uploads/ftp/
	   uploads/members/
	   uploads/replays/

   3.2 Automatic install

       open your web-browser and go to:
       http://your-site/install/

   3.3 Informations

       What does install do:
       - write database informations to file => init/db.php (must be writable)
       - create database if u check
       - create tables in database
       - create user account to log in scripts

       After install u have to remove "install" directory.

       After install u can configure ur scripts in file
       => init/config.php

4. Help
   
   4.1 HELP ME !
       

   4.2 bugs


   4.3 chmod

   4.4 database

       If u dont have database, when u install scripts, near
       field "database" there is checkbox "create new database"
       Just check it and script will create database automatically.
       
       Notice:
       - Usually only root has privillages to create databases

   4.5 Safe-mode

       If your server is running in safe-mode there can be some
       problems with Smarty templates.
       If there are, edit file => init/init.Smarty.php
       and uncomment this line: //$smarty->use_sub_dirs = true;

5. Config
   
   You can configure scripts by editing => init/config.php

6. Templates

   Layout/Graphic/Html of your site can be changed completely
   and this is very easy !

   U dont have to know php to do it, cause php code is seperated
   from html code (all sections except "replays" and "ftp")

   Templates are in templates/ directory

   Page can divided into 3:
   + top page (left menu) # file: templates/header.tpl
   + middle page (centre) # there are many files (for each section 
                            there is another directory in 
                            templates/ dir)
   + bottom page (right menu) # file: templates/footer.tpl

   Quick tutorial on Smarty templates:
   - Smarty code is all between: { }
   - U cannot use this delimeters in your templates, cause
     they are reserved by Smarty, insted of them u can write: 
        {ldelim} = {
        {rdelim} = }
     Remember that if u want to put some javascript code into templates (u can also use-> {literal} any code with braces .. {/literal})
   - {include file="header.tpl"} reads file header.tpl (parse Smarty code then display)
   - {$page} means displaying variable "page"
   - {section} ... {/section} this are loops, they are used to 
     display some code more than one time
   - {if 1==1} ... {/if} the code inside will be executed only if
     condition is true (1==1)
   - {* this is comment *}

   Smarty homepage is => http://smarty.php.net
   Manual: => http://smarty.php.net/manual/en/
   For designers: => http://smarty.php.net/manual/en/smarty.for.designers.php
   
   It is really easy to learn it, even for newbie
   You will know the basics in few minutes

   If ur not satisfied read this:

   http://www.zend.com/zend/tut/tutorial-cezar.php
   http://www.onlamp.com/lpt/a/2689
   
   or this => http://google.com/custom?q=+php+smarty+tutorial
   
   Have fun ;]]

   Notice:
   - Smarty templates are compiled and saved to "_private/templates_c/" directory
     U can delete files in there, if smarty cannot find compiled template there, he will
     compile it again.

7. About MGC system

   7.1 Users auth/rights

       Users can have 4 types of auth:
       - permban
       - normal
       - member (this are clan members)
       - admin

       Users with "member" comes with rights to Admin sections.
       With "rights" u can control to which sections users have access.
   
       Users with "admin" have all rights by default.
   
       If u give user with auth "member" rights to all sections, it will
       differ from "admin" only this that he cant delete "admin" user in
       section ADMIN -> USERS

       Notice:
       - in section "IP ban" every IP can be banned, even if this ip belongs
         to "admin", so pay attention when u give user right to this section !

   7.2 Section IP ban

       User with banned IP cannot log to the site.
       He also cannot create new account.

   7.3 _private dir

       "_private" contains sesnsitive data - you should protect it properly.
       "_private/sessiondata/" contains sessiondata files.
       "_private/templates_c/" contains compiled Smarty templates (read Notice
       at the end of 6. entry [Templates] )

       When making backup or copying site to somewhere else, u can delete files
       from this directories (except index.html).

   7.4 User posts

       Html tags are stripped - users that have auth "normal"
       Admin and members posts - tags are not stripped.

# EOF