----------------------------------------------------------------------
	Map
----------------------------------------------------------------------

1. BBClone Installation instructions
   A. Automatic installation with install.php
   B. Manual BBClone installation
2. Configuring BBClone
3. Using BBclone
4. For specialists
5. Help us


----------------------------------------------------------------------
	1. BBClone Installation instructions
----------------------------------------------------------------------

A. Automatic installation with install.php:
-------------------------------------------

0 - Requirements: the script install.php must have a write access in 
the directory where you install it when it is executed on the server 
through your web browser calling. If this is not the case, you have to 
install BBClone manually (cfr. the Manual BBClone installation section)

1 - Check that an HTTP daemon is running and that PHP support is 
properly configured.

2 - Uncompress all the files in a temporary directory

Example: tar xzvf /tmp/bbclone-xxx.tar.gz

3 - Go to the directory created during the extraction

Example: cd /tmp/bbclone-xxx
		

4 - Go inside the install subdirectory

Example: 
cd /tmp/bbclone-xxx/install

5 - Copy, locally with 'cp' [1] or by ftp for a remote install [2], the file called install.php 
on the server at the place where you want to install BBClone.

Example 1: (local install)
 cp install.php ~/public_html/mybbclone/

Example 2: (remote install)
 ftp ftp.mywebhosting.com
 [ LOGIN/PASSWORD PROCEDURE ]
 cd mybbclone/
 put install.php
	
6 - Open your favorite browser and load the page install.php according to its url on the server (*).
This will decompress all the BBClone archive inside the mybbclone/ subdir.
example: netscape http://www.mywebhosting.com/mybbclone/install.php

(*) Remark: If your server don't support php4 and its extension .php, rename install.php 
with the correct extension and load it as explained before. It will decompress BBClone with the 
correct extensions.
Examples:
	http://www.mywebhosting.com/mybbclone/install.php3
	http://www.mywebhosting.com/mybbclone/install.phtml

WARNING: after a BBClone installation, the install script 'install.php' is automatically deleted.

7 - Include mark_page.php in the php page of your website where the
counter should be placed.

Example: append to the chosen file the following code :
<?
DEFINE ("_BBCLONE_DIR", "mybbclone/");
DEFINE ("_NEW_COUNTER", _BBCLONE_DIR . "mark_page.php");

if(file_exists(_NEW_COUNTER))
{
  include (_NEW_COUNTER);
}

?>

Notice that _BBCLONE_DIR is not only used for the beauty of this include. 
This macro is useful for mark_page.php itself.
So, don't forget to define it.

Remark:
In case you have several marked page, you can name each page for the BBClone page statistics.
For that, add the line 
	define("_BBC_PAGE_NAME","My special page name");
before the mark_page.php including.

8 - The Test:
If all is well installed, the message
	<!-- BBClone v x.xx OK -->
will be displayed in the html output source of all the php files where you have included mark_page.php.

If not, this message will be instead
	<!-- BBClone v x.xx KO -->


B. Manual BBClone installation :
--------------------------------

1 - After having followed the steps 1, 2, 3 and 4 of the previous section, choose a directory on your server where you want to place BBClone, say mybbclone/. 

2 - Reproduce exactly the subdirectory tree of the BBClone source (except the install subdir whihch is not useful) in mybbclone/ and copy all the corresponding files in the right places (this is very important).

3 - Return to the 7th step of the previous section and see the "Configuring BBClone" section to know how to configure your scripts.

----------------------------------------------------------------------
	2. Configuring BBClone
----------------------------------------------------------------------

Edit the file mybbclone/conf/config.php and read careffully all the comments given 
inside and you will be able to set up BBClone as in your dreams ;-)

A display of this configuration is also available through the BBClone page
show_config.php that you can visualize with your browser at the url
	http://www.mywebhosting.com/mybbclone/show_config.php

This configuration can be invisible by setting the variable $BBC_SHOW_CONFIG to 0
in mybbclone/conf/config.php

----------------------------------------------------------------------
	3. Using BBclone
----------------------------------------------------------------------

1 - Wait a few hours/days/weeks for the logs to fill themselves. 

2 - Load the page show_global.php in the directory 
where you installed BBclone, that is, according our example:
	http://www.mywebhosting.com/mybbclone/show_global.php 


----------------------------------------------------------------------
	4. For specialists
----------------------------------------------------------------------

You can directly use the statistics made by BBClone by including the file
access.php located in in your PHP document (providing you give the its 
correct path relatively to your document).

To know exactly the available variable, please take a look to the content 
of this file located in
	mybbclone/var/access.php

It is quite self-explanatory.



----------------------------------------------------------------------
         5. Help us
----------------------------------------------------------------------

Please, help us to improve BBClone by sending us every bugs, remarks, 
wishes or possible improvements.

A lot of help is also needed to translate BBClone in various languages.

Enjoy of BBClone ;-),

The BBClone Team.

