/*
 * PHOTODIR
 * README - Generic readme and installation instructions.
 * Version 1.1, 20-Jan-04
 * Copyright 2004 Ross W. Poulton
 * ross@rossp.org
 * http://www.rossp.org/
 * 
 * This file is part of PhotoDir.
 *
 * PhotoDir is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * PhotoDir is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with PhotoDir; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 * 
 */

###########################
# 0. CONTENTS             #
###########################

	0. Contents
	1. About PhotoDir
	2. Installation
	3. Support
	4. Licensing

###########################
# 1. ABOUT PHOTODIR       #
###########################

    PhotoDir is the result of my frustration with my own image management 
	software, named CrudGallery.  The software required the user to upload
	images one at a time via a web-based interface.

	PhotoDir gets around that by letting you just dump your images in a 
	suitably named directory. It sorts the images and generates neat 
	thumbnails for you.

	PhotoDir allows you to display folders of images on your website, 
	and is ideal for personal webpages, special interest sites, or 
	many other uses! 

	Browsing PhotoDir is similar to browsing a 'My Computer' style window, 
	with neat icons and easy-to-find links.

###########################
# 1. INSTALLATION         #
###########################

	PhotoDir is incredibly easy to install!

		1) Edit photodir.php
			Open the file 'photodir.php' in your favourite text
			editor, and change the variables at the top to suit
			your setup.
			
			$photo_dir  - The full filesystem path (EG Windows or Unix)
			              to the directory that contains your folders of
					 	  images.
			$cache_dir  - A directory where PhotoDir will store its cache 
			              of thumbnails. Needs to be world-writable, and 
						  not inside of $photo_dir.
			$photo_url  - The relative URI to your images from a web 
			              perspective. EG /photos or /photodir
		    $frame_pic  - The picture to have your thumbnails super-imposed
			              on top of.  The thumbnail will be placed in the 
						  centre of this image. I use a white square 104x104
						  pixels with a 1px gray border around the outside.
						  This picture should be in $photo_dir.
			$folder_pic - Picture to use for folders. Mine is the same as 
			              $frame_pic, but with a yellow folder in it, a-la 
						  Windows XP.  This should be inside $photo_dir.
		    $parent_pic - Picture to use for 'Parent Folder' links. I use the 
			              same as $folder_pic, but you may wish to include 
						  a back arrow or similar. Should be inside
						  $photo_dir.
		    $thumb_max  - Maximum width or height for a thumbnail. I use 100
			              pixels.  If an image is 400x200 pixels witha max of
						  100, the thumbnail will become 100x50.
		    
			Thats it!!

		2) Upload the files to your server
			Using SCP or FTP (or any other transfer method your host
			permits) upload all of the files to your website. I 
			recommend having PhotoDir in its own directory, but it 
			is up to you where you place it.  You may rename photodir.php
			without any bad consequences.

		3) Create your photo directories
		    Create a directory as named in $photo_dir, above.  Make sure 
			your $folder_pic, $frame_pic, and $parent_pic are inside this 
			folder.

			Next, create a directory as named in $cache_dir. Make sure this 
			is world-writable (permissions '777', generally) and NOT inside 
			$photo_dir.  This is where your thumbnails will be stored.

	    4) Upload your photos!
		    Inside $photo_dir, create a folder for each of your 'galleries'.
			Then, upload photos into this directory. They will now be 
			browseable!

		5) Play with it
		    Open photodir.php in a web browser, and viola!

###########################
# 3. SUPPORT              #
###########################

	PhotoDir is an UNSUPPORTED product. You must use it at your own
	peril.

	That said, I'm generally more than happy to answer quick questions
	via e-mail at ross@rossp.org. Note this is a privelage, not a right, 
	and I may not have a chance to get back to you. If I don't reply, 
	its most probably as I'm too busy. I apologise in advance for this.

	If you want modifications done, contact me at the above address 
	with what you want done. If I think its likely to be valuable to 
	the general community, I may do it and include it in the next  
	release of PhotoDir.  If it is very website-specific, I'm happy
	to provide a quote to complete the work.

	Lastly, if you've done a modification that you believe is fantastic
	and that everyone should have it, please send it through - after a
	quick review I'll put it in the standard program and you'll get full 
	credit for your work.

###########################
# 4. LICENSING            #
###########################

	PhotoDir is released under the terms of the GNU General Public 
	License (GNU GPL).  Please respect my work and this license. If you
	are too lazy to read the GPL, in the enclosed 'GPL' text file, a 
	brief rundown is here:
		* You may distribute the software as much as you like, providing 
		  you keep credit to me
		* You may modify the software as much as you like, providing you
		  credit me for my work (by all means, take credit for your own
		  work)
		* Any changes that are distributed must be done so under the 
		  terms of the GNU General Public License and must retain my 
		  copyright messages.

EOF
