##################################
## phpMap 0.1 - README          ##
## Author: Jared Breland        ##
## E-mail: jbreland@legroom.net ##
## http://phpmap.sf.net/        ##
##################################


What is phpMap?

phpMap is intended to be an easy-to-use and easy-to-implement Map system, featuring image zooming and navigation, database connectivity to pull information about specific locations, and menu system to allow the user to select the name of a location and have it displayed on the map.

The database component, however, is currently unavailable.  As a result, functionality is limited to just image zooming and navigation.  I will add the database functionality as soon as I've generalized it enough to make it useful for others, but in the meantime, please feel free to try it out as it is, as be sure to send me some feedback!


How does it work?

To use phpMap, two images must be provided - a large, detailed map (or any other image you want to use), and a smaller, scaled down version of the same image.  When a visitor first loads the web page, the scaled down version of the image is loaded.  When he clicks a location on the image, the PHP script gets the location clicked, converts it to the equivilant position on the large image, then "slices" out a portion of the large image centered on the location clicked.  This portion is then displayed, giving the visitor the illusion of "zooming."


What is required?

PHP >= 4.1.2
GD >= 2.0.1
Your map!

Although the versions listed above, I'd highly recommend upgrading to the latest versions of each to make sure all possible security vulnerabilities are taken care of.


How do I install it?

Read the INSTALL file.


Why did you create this?

I created the original version of phpMap for my Senior Project in college.  It was designed specifically to be used as a campus map to identify all key buildings and locations on campus, and to allow visitors to select and building or department on campus through a menu system and then display where on campus it's located.

The project worked well, and since I couldn't find any other freely available app that did anything similar, I decided to, with the permission of my project sponser, GPL it and further develop it on SourceForge.

Unfortunately, because the project was developed specifically for a certain map, using a certain database schema, and a certain menu system, I have to modify the code a good deal to make it usable by others.  This is why, for example, the initial releases of phpMap are missing its database functionality.

I do very much want to make this as easy to use and powerful as possible, though, so PLEASE notify me either through the forums or via e-mail about any bugs you find, and suggestions you have for improvement, etc.  Even better, join the development!  If you're interested, just sent me an e-mail.

I hope you enjoy this product.