Update to SDL version 2.0.1
[supertux.git] / src / SDL2 / README.txt
index 5e9b5d0..681f4a3 100644 (file)
@@ -1,40 +1,38 @@
 \r
-SDL_image 2.0\r
+                         Simple DirectMedia Layer\r
 \r
-The latest version of this library is available from:\r
-http://www.libsdl.org/projects/SDL_image/\r
+                                  (SDL)\r
 \r
-This is a simple library to load images of various formats as SDL surfaces.\r
-This library supports BMP, PNM (PPM/PGM/PBM), XPM, LBM, PCX, GIF, JPEG, PNG,\r
-TGA, and TIFF formats.\r
+                                Version 2.0\r
 \r
-API:\r
-#include "SDL_image.h"\r
+---\r
+http://www.libsdl.org/\r
 \r
-       SDL_Surface *IMG_Load(const char *file);\r
-or\r
-       SDL_Surface *IMG_Load_RW(SDL_RWops *src, int freesrc);\r
-or\r
-       SDL_Surface *IMG_LoadTyped_RW(SDL_RWops *src, int freesrc, char *type);\r
+Simple DirectMedia Layer is a cross-platform development library designed\r
+to provide low level access to audio, keyboard, mouse, joystick, and graphics\r
+hardware via OpenGL and Direct3D. It is used by video playback software,\r
+emulators, and popular games including Valve's award winning catalog\r
+and many Humble Bundle games.\r
 \r
-where type is a string specifying the format (i.e. "PNG" or "pcx").\r
-Note that IMG_Load_RW cannot load TGA images.\r
+SDL officially supports Windows, Mac OS X, Linux, iOS, and Android.\r
+Support for other platforms may be found in the source code.\r
 \r
-To create a surface from an XPM image included in C source, use:\r
+SDL is written in C, works natively with C++, and there are bindings \r
+available for several other languages, including C# and Python.\r
 \r
-       SDL_Surface *IMG_ReadXPMFromArray(char **xpm);\r
+This library is distributed under the zlib license, which can be found\r
+in the file "COPYING.txt".\r
 \r
-An example program 'showimage' is included, with source in showimage.c\r
+The best way to learn how to use SDL is to check out the header files in\r
+the "include" subdirectory and the programs in the "test" subdirectory.\r
+The header files and test programs are well commented and always up to date.\r
+More documentation and FAQs are available online at:\r
+       http://wiki.libsdl.org/\r
 \r
-JPEG support requires the JPEG library: http://www.ijg.org/\r
-PNG support requires the PNG library: http://www.libpng.org/pub/png/libpng.html\r
-    and the Zlib library: http://www.gzip.org/zlib/\r
-TIFF support requires the TIFF library: ftp://ftp.sgi.com/graphics/tiff/\r
+If you need help with the library, or just want to discuss SDL related\r
+issues, you can join the developers mailing list:\r
+       http://www.libsdl.org/mailing-list.php\r
 \r
-If you have these libraries installed in non-standard places, you can\r
-try adding those paths to the configure script, e.g.\r
-sh ./configure CPPFLAGS="-I/somewhere/include" LDFLAGS="-L/somewhere/lib"\r
-If this works, you may need to add /somewhere/lib to your LD_LIBRARY_PATH\r
-so shared library loading works correctly.\r
+Enjoy!\r
+       Sam Lantinga                            (slouken@libsdl.org)\r
 \r
-This library is under the zlib License, see the file "COPYING.txt" for details.\r