Fixed up the test for video_set_colors
[sdlgit/SDL_perl.git] / lib / SDL.pm
index 97d65b1..094dd12 100644 (file)
@@ -3,7 +3,7 @@
 # SDL.pm
 #
 # Copyright (C) 2005 David J. Goehrig <dgoehrig@cpan.org>
-#
+# Copyright (C) 2009 Kartik Thakore   <kthakore@cpan.org>
 # ------------------------------------------------------------------------------
 #
 # This library is free software; you can redistribute it and/or
@@ -24,8 +24,8 @@
 #
 # Please feel free to send questions, suggestions or improvements to:
 #
-#      David J. Goehrig
-#      dgoehrig@cpan.org
+#      Kartik Thakore
+#      kthakore@cpan.org
 #
 
 package SDL;
@@ -54,7 +54,7 @@ sub import {
   $self->export_to_level(1, @_);
   SDL::Constants->export_to_level(1);
 }
-$VERSION = '2.2.2.17';
+$VERSION = '2.3';
 
 print "$VERSION" if (defined($ARGV[0]) && ($ARGV[0] eq '--SDLperl'));
 
@@ -101,34 +101,83 @@ and Perl.  This document describes the low-level functional SDL_perl API.  For t
 object oriented programming interface please see the documentation provided on a
 per class basis.
 
+=head1 The SDL Perl 2009 Development Team
+
+=head2 Documentation
+
+       Nick: magnet
+
+=head2 Perl Development
+
+       Nick: Garu
+       Name: Breno G. de Oliveira
+       
+       Nick: Dngor
+       Name: Rocco Caputo
+
+       Nick: nferraz
+       Name: Nelson Ferraz
+
+       Nick: acme
+       Name: Leon Brocard
+       
+       Nick: FROGGS
+       Name: Tobias Leich
+
+=head2 Maintainance 
+       
+       Nick: kthakore
+       Name: Kartik Thakore
+
+=head1 MacOSX Experimental Usage
+
+Please get libsdl packages from Fink
+       
+       perl Build.PL
+       perl Build test
+       perl Build bundle
+       perl Build install
+
+=head2 Running SDL Perl Scripts in MacOSX
+
+First set the PERL5LIB environment variable to the dependencies of your script
+       
+       %export PERL5LIB=$PERL5LIB:./lib
+
+Use the SDLPerl executable made in the bundle and call your scripts
+
+       %SDLPerl.app/Contents/MacOS/SDLPerl yourScript.pl
+
+=head1 Functions exported by SDL.pm
+
 =head2 Init(flags) 
 
 As with the C language API, SDL_perl initializes the SDL environment through
 the C<SDL::Init> subroutine.  This routine takes a mode flag constructed through
-the bitwise OR product of the following functions:  
+the bitwise OR product of the following constants:
 
 =over 4
 
 =item *
-INIT_AUDIO()
+INIT_AUDIO
 
 =item *
-INIT_VIDEO()
+INIT_VIDEO
 
 =item *
-INIT_CDROM()
+INIT_CDROM
 
 =item *
-INIT_EVERYTHING()
+INIT_EVERYTHING
 
 =item *
-INIT_NOPARACHUTE() 
+INIT_NOPARACHUTE
 
 =item *
-INIT_JOYSTICK()
+INIT_JOYSTICK
 
 =item *
-INIT_TIMER()
+INIT_TIMER
 
 =back