 ******************************************************************************************
 *                           /==============================\                             *
 *                        ~~||     PHP My Ring v. 4.0.2     ||~~                          *
 *                           \==============================/                             *
 *                                                                                        *
 * Program realized by Nicolas G. <webring@microniko.net> http://www.microniko.net        *
 * To see a demo installation of this webring program, please visit the following         *
 * web page on microbiology:                                                              *              
 *                    -----> http://www.microniko.net/webring <-----                      *
 *                                                                                        *
 * Distributed under the GNU General Public License. (see the files COPYING and GPLfr)    *          
 * You must absolutely accept the terms of this license before using this program!!       *
 * If you make modifications to the program, please send me a e-mail, so that I can        *
 * update my sources. =:-}                                                                 *
 ******************************************************************************************

1/ Description
   -----------
   This webring program permits you to install and run a webring on your website.
   It can be easily customized by both the webring's administrator, and the webring's members,
   with a minimum of effort.
   It is also possible to modify and/or customize this webring program using a WYSIWYG editor, but
   please be careful not to edit any of the PHP code when doing so!!!! Some of these uppity
   WYSIWYG editors will make changes to the code without any input from you. So, I ask that you
   please regularly save and test your work after each time you have made a modification.
   This program is powered by PHP 4 (necessary for sessions), and for optimal performance should
   preferably be installed on platforms other than Win32 (GNU/Linux), and a server supporting the
   mail() function. This webring program also requires that you have a MySQL database.

2/ New Versions
   ------------------
   To verify that the version you have (v 4.0.2) is the latest version, please visit
   the website http://www.phpmyring.fr.st.
   Then consult the change.log file for the latest changes that were made to this version.
   
   To update your copy of the program, first delete all the old files (It is always wise to 
   save a copy of them before doing so...), and then go to the URL address:
   http://YOUR_DOMAIN/YOUR_WEBRING_FOLDER/install/
   Then choose the "Update" installation option.
   The program will then regenerate.

3/ Installation
   ------------ 
   a- On a site not already having a webring, or that has version 2.x
      ----------------------------------------------------------------
   * Decompress the archival file (with the option "Use Folder Name").
   * If the mail() function has been deactivated on your server, then modify the courrier()
     function in the 'include/fonctions.php' file.
   * Customize the pages haut.php & bas.php, they will appear on all pages.
   * You can customize the appearance of your webring by editing the /include/script.php file, 
     and the /include/styles.php file (CSS). See the file /install/description_styles for further
     info on the various style classes used.
   * Edit the file /include/config.php with the variables needed to access your MySQL database.
   * Upload all files to your server, and then chmod the /include/ folder 777.
   * Run the program's configuration by going to the webpage
     http://YOUR_DOMAIN/YOUR_WEBRING_FOLDER/install/ 
     A few questions will be asked of you, and then the program will automatically create the
     configuration file and MySQL tables (If this is the first time you have installed the
     webring) for you. If you would rather manually install the program, you can do so by using
     the config_default.php file, which I have left in the /install/ folder. To then create the
     MySQL tables manually you would use the create.sql file.
   * Do not remove the /install/ folder, if you do so you will no longer be able to modify the
     configuration of your webring.    
   * This program uses sessions. Therefore you will need (For certain kinds of servers) a folder
     to gather together the files generated during these sessions. This is the /tmp/ folder.     
     Verify where this folder should be situated by using the phpinfo() function.
   * Test out your new webring.....


   b- On a site already having a webring installed
      -----------------------------
      ################################################################################
      ##      IF YOU ARE USING A VERSIONN < 4.0:                                    ##
      ##      - Save a copy of the contents of your MySQL table "webring"           ##
      ##        and then delete it.                                                 ##
      ##      - Choose the "INSTALLATION" installation option.                      ##
      ##      - Restore the data of the MySQL table "webring".                      ##
      ################################################################################

      * Delete all the old files (It is always wise to save a copy of them before doing 
        so...), and then go to the URL address:
        http://YOUR_DOMAIN/YOUR_WEBRING_FOLDER/install/
        Then choose the "Update" installation option.
        The program will then regenerate.
        You can benefit from this by making further modifications if you wish.

4/ Downloads
   ----------
   To download the latest version of PHP My Ring or a recent translation, 
   please consult the download page hosted at SourceForge:
   http://sourceforge.net/project/showfiles.php?group_id=67828
   and then follow the latest installation directions found within.
  
5/ What is left to be done
   ------------------------
   See the TODO file.
   Also please do not hesitate to send me your ideas, commentary, 
   and any suggestions you might have!
   Send them to me at: 
   webring@microniko.net

6/ Distribution notes
   -------------------
   If you would like to make a contribution to this program, then please do not hesitate in 
   doing so. Conforming of course to the spirit of the GNU General Public License, all I ask 
   is that you do not remove any notices currently present in the code. It would also be great 
   if you were to inform me of your contribution, so that I could then add your contribution 
   to the latest modified version of the program.

7/ !!HELP!! I've got problems!
   ----------------------------
  
   In case of any problems:
   Do not PANIC or go nuts. There is always a solution... Certain errors constantly re-surface.

   Please verify that you have correctly configured your copy of this program, and that PHP 4 
   and MySQL are both installed on your server.

   If after having verified all of the above, and there is still something screwing things up,
   then this is what you need to do:
   - Gather together as much info as possible on the error/s (Version of PHP and PHP My Ring, the
     error message/s displayed by PHP, and anything else that passes through your head... 
     No provided info is ever considered useless!).
   - Join the mail list
     http://lists.sourceforge.net/lists/listinfo/phpmyring-devel
   - Join the forum
     http://sourceforge.net/forum/forum.php?forum_id=231018
   - Send me a e-mail (webring@microniko.net) with the URL address where the error/s are
     displayed, how I can reproduce them, and also including the contents of the MySQL table
     webring_conf and the file config.php (Password/s removed if not required to 
     resolve the error/s).
   - If you were finally able to install PHP My Ring despite the occasional error or two, then
     please do not hesitate to send me a bug report using the utility provided to do so, which 
     is found in your ring's administration section.

   I would be delighted to HELP you, but can only do so if the info provided is as clear and
   precise as you can possibly make it!!!!!

   Note: Many Ringmasters have sent me messages saying that their administration password 
   (The password listed in /include/config.php) does not work! In ALL cases it has been a 
   little misunderstanding between what is ring administration, and what is site administration:
   - The web page '/webring/admin.php' is the page for site administration, which is the page a
     ring's members would use. 
   - The web page '/webring/admin/index.php' is the page for ring
     administration, which is the page a Ringmaster would use (You are the Ringmaster!).

8/ Tips and tricks
   ---------------
   I strongly recommend that you use the software program:
   HAPedit (http://hapedit.free.fr)
   This software program is simply the best!!
   PHPMyRing was developed using this software program.
