X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=README;h=65a60426038e337ca52e16f663d2d3027733b24a;hb=HEAD;hp=f013bb0b0cc07256cea0e33056c403554a552c55;hpb=7190cbefa257b8d16ca338cba7924f9b471bfe7c;p=sdlgit%2FSDL_perl.git

diff --git a/README b/README
index f013bb0..65a6042 100644
--- a/README
+++ b/README
@@ -1,89 +1,52 @@
-README for SDL_Perl-2.2.1
+NAME
+    SDL_perl - Simple DirectMedia Layer for Perl
 
-What's New in 2.2.1:
+SYNOPSIS
+      use SDL;
 
-SDL_Perl-2.2.1
-Adds critical bug fixes in the following areas:
--SDL and Constants
--SFont and TTFont 
--SDL::Tutorial
+DESCRIPTION
+    SDL_perl is a package of perl modules that provides both functional and
+    object orient interfaces to the Simple DirectMedia Layer for Perl 5.
+    This package does take some liberties with the SDL API, and attempts to
+    adhere to the spirit of both the SDL and Perl. This document describes
+    the low-level functional SDL_perl API. For the object oriented
+    programming interface please see the documentation provided on a per
+    class basis.
 
-Prerequisites:
+The SDL Perl 2009 Development Team
+  Documentation
+            Nick: magnet
 
-SDL Perl recommends installing the following libraries available
-from http://www.libsdl.org/ prior to installing:
+  Perl Development
+            Nick: Garu
+            Name: Breno G. de Oliveira
+            
+        Nick: Dngor
+            Name: Rocco Caputo
 
-	SDL-1.2.8
-	smpeg-0.4.5
-	SDL_image-1.2.4
-	SDL_mixer-1.2.6
-	SDL_sound-1.0.1
-	SDL_net-1.2.5
-	SDL_gfx-2.0.13
-	SDL_ttf-2.0.7
-	SDL_svg-1.1.9
-	SDL_vnc-1.0.0
+            Nick: nferraz
+            Name: Nelson Ferraz
 
-Additionally the following Perl modules should be installed:
+  Maintainance
+            Nick: kthakore
 
-	Module-Build-0.22
-	Test-Simple-0.62
+            Name: Kartik Thakore
 
-Installation:
+MacOSX Experimental Usage
+    Please get libsdl packages from Fink
 
-	perl Build.PL
-	./Build
-	./Build test
-	./Build bundle	# MacOS X only!
-	./Build install
+            perl Build.PL
+            perl Build test
+            perl Build Bundle
+            perl Build install
 
-Installation with Windows + MinGW:
+  Running SDL Perl Scripts in MacOSX
+    First set the PERL5LIB environment variable to the dependencies of your
+    script
 
-	set SDL_INST_DIR=Absolute/Path/to/SDLdir
-	perl Build.PL
-	./Build
-	./Build test
-	./Build install
+            %export PERL5LIB=$PERL5LIB:./lib
 
+    Use the SDLPerl executable made in the bundle and call your scripts
 
-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>
+            %SDLPerl.app/Contents/MacOS/SDLPerl yourScript.pl