______________________________________________
       _      _  ___     _____    ___   _____
 _ __ (_) ___| |/ / |   | ____|  / _ \ |___ /
| '_ \| |/ __| ' /| |   |  _|   | | | |  |_ \
| |_) | | (__| . \| |___| |___  | |_| | ___) |
| .__/|_|\___|_|\_\_____|_____|  \___(_)____/
|_|
______________________________________________


_____________________

   WHAT IS PICKLE?
_____________________

picKLE is an image gallery system created in PHP.  It generates thumbnails and resampled images 
on the fly and caches them.  It is made to be extremely simple to install/configure.


__________________

   REQUIREMENTS
__________________

- a webserver (http://www.apache.org)
- PHP (http://www.php.net)
- ImageMagick (http://www.imagemagick.org/)


__________________

   INSTALLATION
__________________

IF YOU ARE UPGRADING SEE UPGRADING BELOW

SEE QUICK INSTALL

(tested with apache 1.3.27 and php 4.3.2 - both win32 and unix/linux)
- Move the picKLE directory to a path accessable to the web  
- Edit the picKLE-conf.php and make any changes
- chmod 777 picKLE-cache (win32 make sure webserver can write to picKLE-cache)
- Place directories of jpg, jpeg, gif, and png file in the picKLE-albums directory
- Edit header.php and footer.php in picKLE-includes if you want to add your sites header and footer 

___________________

   QUICK INSTALL
___________________

What the hell, the steps above to install a program two much for you?


_______________

   UPGRADING
_______________


Move the new index.php, picKLE-conf.php, and style.css to your current running system which will 
replace the existing index.php, picKLE-conf.php, and style.css.  Also, mv the new picKLE-images to
your current running system and overwrite the existing picKLE-images dir and the files within.


__________________

   HOW IT WORKS
__________________

After you place images/directories in the picKLE-albums directory the first time you view
them online via picKLE it will create your thumbnails and resample your images and place them
in the picKLE-cache directory.  The first time you view them online via picKLE it may seem slow, 
it is only like this the first time.  The second time and thereafter it will access the resampled
and thumbnails from the cache directory.


__________________

   DESCRIPTIONS
__________________

If you want descriptions on your albums and pics, in the directory you want a description for make
a file picture.jpg.txt for picture descriptions and album.txt for directory descriptions.  Otherwise,
if the txt files are not their nothing will show up.

ie. Say in the picKLE-albums directory you make a directory called NaughtyPictures and in that 
directory you have a picture called girlfriend.jpg.  In the NaughtyPictures directory place a text
file called album.txt and girlfriend.jpg.txt with text of the description of the directory
and file.


_____________________

   TROUBLESHOOTING
_____________________

If you get chdir and/or mkdir errors there are two things that could be wrong.  You didn't chmod 777
the picKLE-cache directory or you are running an old version of php.  Another reason for this error is
that the webserver user doesn't have the command convert in it's path.  To fix this in to picKLE-conf
file place the path that the command convert is in.

If you are getting stat errors, you are running an old and most likely vulnerable version of php.  

You may want to set picKLE_debug='1' in the picKLE-conf.php if you are still having problems.

_________________

   SUGGESTIONS  
_________________

Any suggestions would be great.
picKLE@linuxfiend.com