Updated SDL::Event docs

[sdlgit/SDL_perl.git] / README

diff --git a/README b/README
index e3902cd..4492373 100644 (file)
--- a/README
+++ b/README
@@ -1,19 +1,97 @@
-README for SDL_Perl-2.2
+README for SDL_Perl-2.2.2
 
-First step is to make SDL perl pass all tests in 
-t/.
+What's New in 2.2.2:
 
-I will add these as a issue.
+SDL_Perl-2.2.2
 
-Simple Run:
-perl Build.PL
-perl Build 
-perl Build test
-perl Build install
+       -Made App loop() faster https://rt.cpan.org/Public/Bug/Display.html?id=16988
+       -Patched support for add support for gluquadric* sub https://rt.cpan.org/Public/Bug/Display.html?id=25598
+       -Made App init slimer https://rt.cpan.org/Public/Bug/Display.html?id=16987
+       -Added faster SDL::Color alternative https://rt.cpan.org/Public/Bug/Display.html?id=17975
+       -Added better error reporting for TTFont errors
+       -Added win32 support https://rt.cpan.org/Ticket/Display.html?id=49003
+       
 
-There are more test scripts in test/
+Prerequisites:
 
-Disclaimer: This might be moved to CPAN when I get access
+SDL Perl recommends installing the following libraries available
+from http://www.libsdl.org/ prior to installing:
 
-kthakore <thakore.kartik@gmail.com>
-1 August 2009
+       SDL-1.2.8
+       
+       Recommended:
+       SDL_image
+       SDL_mixer
+       SDL_ttf
+       smpeg
+
+       Optional Libraries:
+       *SDL_gfx
+       *SDL_sound
+       *SDL_net
+       *SDL_svg
+       *SDL_vnc
+
+Additionally the following Perl modules should be installed:
+       
+       Alien-SDL-0.2
+       Module-Build-0.22
+       Test-Simple-0.62
+
+Installation:
+
+       perl Build.PL
+       ./Build
+       ./Build test
+       ./Build bundle  # MacOS X only!
+       ./Build install
+
+Installation with Windows (Strawberry) :
+
+       perl Build.PL
+       ./Build
+       ./Build test
+       ./Build install
+
+
+The build process will use the new Module::Build facility
+to auto detect and build SDL Perl for your platform.  If
+the build fails please forward bugs to sdl-devel@perl.org.
+
+For MacOS X users there is a new experimental bundle, 
+that is called SDLPerl.app.  You can use this bundle
+to run perl scripts with a .spl extension, you know,
+SDL Perl files.  We will work on brining this style 
+launcher and an integrated development environment to
+all platforms shortly.
+
+Documentation:
+
+Each module now includes its own documentation, and 
+is accessible through perldoc.  Additional tutorials,
+code, and tips can be found at the website:
+
+       http://sdl.perl.org
+
+Online documentation and tutorials are available through
+perldoc module.  
+
+Contributing:
+
+Anyone wishing to contribute modules, sprite engines, documentation,
+and anything else that others might find useful, please join
+the mailing list:
+
+       sdl-devel@perl.org
+
+This is a mailing list for those interested in SDLperl development,
+both as an applications developer, and as a core contributor.
+
+I am always more than happy to take patches, bug reports, and
+helpful suggestions.  It is feedback, both good and poor, that
+keeps projects like this going.
+
+Enjoy,
+
+David J. Goehrig <dgoehrig@cpan.org>
+Kartik Thakore <kthakore@cpan.org>