/INSTALL

  1------------------------------------------------------------------------------
  2| SDL Perl
  3| INSTALL Information Doc
  4-------------------------
  5
  6Table of Contents:
  7-----------------
  8  * System Requirements
  9  * Grabbing the Necessary Version of SDL Perl, Release
 10  * Same as Above, but Bleeding Edge
 11
 12System Requirements:
 13-------------------
 14
 15SDL Perl's package on your system should be able to install everything needed
 16for the SDL module to be properly installed. FYI, this may include the
 17following libraries (as pre-compiled DLLs for Microsoft Windows platforms):
 18
 19  * libSDL
 20  * png
 21  * tiff
 22  * jpeg
 23  * smpeg
 24  * OpenGL (GL)
 25  * GLUT   (GLU)
 26  * SDL_image
 27  * SDL_mixer
 28  * SDL_gfx
 29  * SDL_ttf
 30
 31Grabbing the Necessary Version of SDL Perl, Release:
 32---------------------------------------------------
 33
 34It might be a good idea to run from your shell prompt (where the '$' dollar-
 35sign denotes the prompt itself, so what you should type follows it):
 36
 37  $ cpan
 38
 39You will be presented with the CPAN prompt at this point.
 40
 41  CPAN> upgrade /.*/
 42
 43Yeah, CPAN> denotes we are now prompted inside CPAN and recommending upgrading
 44everything out-of-date. Then with your site up-to-date:
 45
 46  CPAN> install SDL
 47
 48This should fully prepare you to run and program SDL Perl applications.
 49
 50Same as Above, but Bleeding Edge:
 51--------------------------------
 52
 53As of Thu Mar 17, 2011, you'll need git installed on your machine in order to
 54clone from GitHub by running:
 55
 56  $ git clone https://GitHub.Com/PerlGameDev/SDL.git
 57
 58To update your clone, go into the directory that the git repo is in
 59(i.e., into the git repo itself, not merely the directory that you did the
 60`git clone` in) and type the following:
 61
 62  $ git pull
 63
 64Now to build, run:
 65
 66  $ perl Build.PL
 67
 68Then to test:
 69
 70  $ perl Build test
 71
 72Only MacOS used to also require you to:
 73
 74  $ perl Build bundle
 75
 76... but that shouldn't be necessary anymore.
 77
 78Katrina Payne (the original author of this file) had a cute anecdote here
 79about SDL Perl being a blushing girl who fails testing and enjoys watching
 80InuYasha. Quirky! ;) I couldn't quite bear to replace it all so here's her
 81paragraph of glory from Thu Oct 22, 2009:
 82
 83  "Then if there is an issue getting herself all pretty this command will have 
 84her just stop there... your best bet is to give her comfort food. Of the 
 85kind of reports on the SDL Perl tracker, as I am not really certain if SDL 
 86Perl likes Hagan Daaz, but then I have not ask her, and well, you really are 
 87not in the place to ask. After all, she will likely blame you or your system 
 88for why she does not look pretty--programs that end up not compiling 
 89properly tend to have self esteem issues. Sending something to the tracker 
 90pretty much is a way of telling her you are interested... this usually helps 
 91her to stop watching old reruns of Inu Yasha (yeah, SDL Perl is still kind of 
 92young) and get back to feeling better."
 93
 94Finally you're done with melodramatic testing and ready to type:
 95
 96  # perl Build install
 97
 98The '#' above denotes that this command should be entered from a root or
 99super-user account which has sufficient module installation permissions.
100
101Then your installation of SDL Perl should be complete. Yay! Enjoy! =)