README for SDL Perl Kitchen Sink
--------------------------------

Introduction
------------

This distribution contains everything needed to get SDL Perl 1.20.3 up and
running under Mac OS X. It's really just a convenience to save the trouble
of tracking down all the sources and frameworks separately and figuring out
where to install them. The core of the distribution is a modified version of
SDL Perl 1.20.3 (see www.sdlperl.org) which resolves some conflicts with
native Mac OS X libraries, and sets the compiler directives correctly.

For the latest version of this distribution, please visit

   http://ttongue-skunkworks.imagiware.com/Code/


Distribution Layout
-------------------

This distribution has the following contents:

	README	   -    This file.
	bin	   -	Misc binaries generated from builds of libjpeg and
			libpng
	frameworks -   	The required SDL developer packages.
	include	   - 	Header files for libjpeg, libpng and ogg/vorbis
	lib	   - 	Precompiled libraries for libjpeg, libpng and ogg/vorbis
	man        -    Man pages for the libraries
	src        -    This directory contains the expanded source dirs used
			to build the libraries found in lib, along with the
		 	modified SDL-perl-1.20.3 dir that can be used to build
			the Perl Modules.
	tars	   -    Original tar files for the pre-built libraries, and for
			SDL_perl-1.20.3 for comparison with the contents of src.
			SDL_perl-1.20.3.macos.tgz is a tar file of the 
			src/SDL_perl-1.20.3 directory.

Getting Started
---------------

Here is a list of steps needed to get SDL Perl working from the Kitchen Sink:

	1.) Unpack the Kitchen Sink distribution in a convenient location.
	    I *don't* recommend installing the files in bin, include, etc in
            system level directories, but that is just a personal neatness 
            preference.

	2.) Set your DYLD_LIBRARY_PATH to include the path to the Kitchen 
            Sink's lib directory. If you're using csh for your shell, you can
	    edit your ~/.cshrc and add:
	
		setenv DYLD_LIBRARY_PATH $DYLD_LIBRARY_PATH:/path/to/lib

	3.) Install the frameworks from the frameworks directory. Each of the
	    packages will install the frameworks in ~/Library/Frameworks. 
	    The SDL_Perl makefile is expecting them in 
	    /System/Library/Frameworks, so you can either modify the Makefile 
            or move the frameworks to /System/Library/Frameworks after you've
            finished running all the installers

        4.) Build SDL_Perl. You should browse through README.macosx file in the 
	    src/SDL_Perl-1.20.3 directory, since it has some caveats and 
	    warnings, but the the basic steps are:

		cd src/SDL_perl-1.20.3
		perl Makefile.PL
		make 
		make test
		make install

	5.) That's it! You can try out the new SDL perl module using some of the
            samples found in src/perl_samples.


References
----------

Here is a list of references for where I found various files:

         SDL-devel.pkg            	    www.libsdl.org
         SDL_mixer-devel.pkg        	    www.libsdl.org
         SDL_image-devel.pkg      	    www.libsdl.org
         SDL_ttf-devel.pkg        	    www.libsdl.org
	 SDL_Perl-1.20.3.tgz	  	    www.sdlperl.org
         oggvorbis-macosx-libs-1.0.tar.gz   www.xiph.org 
         libpng-1.2.5.tar.gz   		    www.libpng.org/pub/png/libpng.html 
         jpegsrc.v6b.tar.gz   		    www.ijg.org 

The modifications to SDL_perl-1.20.3 owe a big debt to a port of Frozen Bubble
done by bob@redivi.com (see redivi.com/~bob/frozenbubble.html), including a 
workaround for a namespace conflict with some Mac OS X libraries due to 
flat-namespace restrictions.


Questions, Comments, Concerns?
------------------------------ 

Let me know if you've found this distribution useful, and any enhancements you
might make. Thanks!

--Thomas Tongue <ttongue@imagiware.com>, 5/9/03