X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=README;h=65a60426038e337ca52e16f663d2d3027733b24a;hb=128c8327685b245d2688aff94fae9b3fef280473;hp=339c14c9c67627845d6c4f060c6cd05b48bfd5ea;hpb=61b734fc9fbe558a23d06e8e23cd715b8a56366a;p=sdlgit%2FSDL_perl.git

diff --git a/README b/README
index 339c14c..65a6042 100644
--- a/README
+++ b/README
@@ -1,12 +1,52 @@
-README for SDL_Perl-2.2
+NAME
+    SDL_perl - Simple DirectMedia Layer for Perl
 
-First step is to make SDL perl pass all tests in 
-t/.
+SYNOPSIS
+      use SDL;
 
-I will add these as a issue.
+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.
 
-more to come ...
-this might be moved to CPAN when I get access
+The SDL Perl 2009 Development Team
+  Documentation
+            Nick: magnet
+
+  Perl Development
+            Nick: Garu
+            Name: Breno G. de Oliveira
+            
+        Nick: Dngor
+            Name: Rocco Caputo
+
+            Nick: nferraz
+            Name: Nelson Ferraz
+
+  Maintainance
+            Nick: kthakore
+
+            Name: Kartik Thakore
+
+MacOSX Experimental Usage
+    Please get libsdl packages from Fink
+
+            perl Build.PL
+            perl Build test
+            perl Build Bundle
+            perl Build install
+
+  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
 
-kthakore <thakore.kartik@gmail.com>
-1 August 2009