Read Me

====================================================================================================
PHP-Mugbook 1.0.0
http://php-mugbook.sourceforge.net/
====================================================================================================


====================================================================================================
== License ==

Please find the license terms for this software in the file called 'license' at the root of the package.


====================================================================================================
== Where do I get the latest release? ==

	browse to https://sourceforge.net/project/showfiles.php?group_id=175216
or
	svn checkout https://svn.sourceforge.net/svnroot/php-mugbook/

====================================================================================================
== Getting started: Before you run the install script ==

Unpack the archive file into a directory, let's say php-mugbook. This is the base directory for php-mugbook, so make sure you put it where you want it to permanently reside before you run script/install.  This should be *outside* of the webroot for security reasons!  Later, you will create a symlink from inside your webroot to the www subdirectory of this php-mugbook directory.

Please make sure you have Pear::DB installed and you know the path to the pear php libraries. You will be asked for it during installation.

You also need to have your database created, and make sure that the user you supply to the install script has permission to add tables and insert records.

Example:

	mysql -u root --password --host=db.myhost.com
	> create database mugbook;

====================================================================================================
== Running the install script ==

Please make sure you are in the base directory before you run the installer.  You can invoke the installer with script/install  

Run script/install . This is what a sample installation looks like:
	What is the absolute path to the Pear::DB libraries? /usr/local/share/pear
	What is the full path to your web root (for example, /home/groups/p/ph/php-mugbook/dev/htdocs)? /home/groups/p/ph/php-mugbook/htdocs
	What is the domain name for your web site (for example, www.example.com)? php-mugbook.sourceforge.net
	What is the part of the URL that comes after the domain (for example, /~user/ or just /)? /demo/
	What is the hostname of your database server? mysql4-p.sourceforge.net
	What is your database's name? p175216_phpmugbook_demo
	What is your database username? p175216admin
	What is your datbase password? yeah_right
	Please wait while your database is initialized .... done!

This will put database authentication information in script/db and lib/organization/config.php

Edit pre_volume_config.php and set up some information about your volumes.

Create a symlink in your webroot that points to php-mugbook/www by executing "ln -s ./www /path/to/your/webroot" from this base directory.
Example:
	/home/groups/p/ph/php-mugbook/htdocs]$ ln -s ../dev/php-mugbook/www demo

====================================================================================================
== What's next? ==

* Edit pre_volume_config.php and set up some information about your volumes.
* Create a symlink in your webroot that points to php-mugbook/www by executing "ln -s ./www /path/to/your/webroot" from this base directory.
* Edit page.php and create a nice-looking template for you site.
* Fix/change all the leftover references to {Mugbook}, etc. Replace those with a variable containing the name of your mugbook, etc.
* Create profiles
* Add some data to the hobby lists, etc.
* Have fun!

====================================================================================================
== How do I contribute to this project? ==

* Become a developer
* Fix bugs
* Start working on some of the cleanup / features suggested in the file to_do.txt
* Sign up to help with the project at https://sourceforge.net/projects/php-mugbook/

====================================================================================================
== Why did you (the original authors) abandon this project? ==

So that we could focus all our attention on Uebermug (http://sourceforge.net/projects/mugbook/)