README
author Sam Lantinga <slouken@libsdl.org>
Sun, 10 Mar 2013 09:03:38 -0700
changeset 6987 7084af936d82
parent 6878 30579e86ac24
permissions -rw-r--r--
Fixed bug 1748 - Patch for errors and mistakes in SDL 2 README files.

Philipp Wiesemann

SDL's README files seem to contain multiple errors and mistakes. I attached a patch with changes and updates.

README:
* removed Windows CE because no more supported

README-SDL.txt:
* corrected spelling mistake

README.DirectFB:
* corrected spelling mistakes

README.MacOSX:
* corrected spelling mistakes

README.Platforms:
* changed Android version to match AndroidManifest.xml

README.Porting:
* added missing directories from list
* removed cdrom directories from list

README.android:
* updated required NDK revision
* add project.properties to list
* changed lower limit for to android-10 and removed upper
* added a statement why older devices not supported
* added correct dates to statements about OpenGL ES
* added info about Google's device numbers and date
* corrected spelling mistakes

README.gesture:
* corrected spelling mistakes

README.pandora:
* corrected spelling mistake

README.touch:
* changed that values are no in range 0..1
* updated the names of some functions
* updated the notes about usage
* corrected spelling mistakes
* added info that API changed near original author contact
     1 
     2                          Simple DirectMedia Layer
     3 
     4                                   (SDL)
     5 
     6                                 Version 2.0
     7 
     8 ---
     9 http://www.libsdl.org/
    10 
    11 This is the Simple DirectMedia Layer, a general API that provides low
    12 level access to audio, keyboard, mouse, joystick, 3D hardware via OpenGL,
    13 and 2D framebuffer across multiple platforms.
    14 
    15 The current version supports Windows, Mac OS X, Linux, FreeBSD,
    16 NetBSD, OpenBSD, BSD/OS, Solaris, iOS, and Android. The code contains
    17 support for other operating systems but those are not officially supported.
    18 
    19 SDL is written in C, but works with C++ natively, and has bindings to
    20 several other languages, including Ada, C#, Eiffel, Erlang, Euphoria,
    21 Go, Guile, Haskell, Java, Lisp, Lua, ML, Objective C, Pascal, Perl, PHP,
    22 Pike, Pliant, Python, Ruby, and Smalltalk.
    23 
    24 This library is distributed under the zlib license, which can be found
    25 in the file "COPYING".
    26 
    27 The best way to learn how to use SDL is to check out the header files in
    28 the "include" subdirectory and the programs in the "test" subdirectory.
    29 The header files and test programs are well commented and always up to date.
    30 More documentation and FAQs are available online at:
    31 	http://wiki.libsdl.org/
    32 
    33 If you need help with the library, or just want to discuss SDL related
    34 issues, you can join the developers mailing list:
    35 	http://www.libsdl.org/mailing-list.php
    36 
    37 Enjoy!
    38 	Sam Lantinga				(slouken@libsdl.org)
    39