Fixed the pod path in archive

[sdlgit/SDL_perl.git] / README

diff --git a/README b/README
index e3902cd..65a6042 100644 (file)
--- a/README
+++ b/README
@@ -1,19 +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.
 
-Simple Run:
-perl Build.PL
-perl Build 
-perl Build test
-perl Build install
+The SDL Perl 2009 Development Team
+  Documentation
+            Nick: magnet
 
-There are more test scripts in test/
+  Perl Development
+            Nick: Garu
+            Name: Breno G. de Oliveira
+            
+        Nick: Dngor
+            Name: Rocco Caputo
 
-Disclaimer: This might be moved to CPAN when I get access
+            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