/INSTALL

http://github.com/PerlGameDev/SDL · #! · 101 lines · 71 code · 30 blank · 0 comment · 0 complexity · 5dbb339dc69586ff502a9dddf4679975 MD5 · raw file

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