README
author Holmes Futrell
Fri, 15 Aug 2008 00:46:58 +0000
branchgsoc2008_iphone
changeset 2427 32b9909db651
parent 2062 c9aa6bcb26f3
child 3269 a67a961e2171
child 3976 8582c6a5ca16
permissions -rw-r--r--
changed macro MAX_G_FORCE to SDL_IPHONE_MAX_GFORCE and moved it to the SDL_config_iphoneos.h file. This should allow users to convert between the Sint16 returned by polling the joystick and units of g-force, which better describe what is going on with the iPhone (and are what the iPhone OS actually gives you). This conversion wouldn't be necessary except that we'd need floating point to store everything as g-force.
     1 
     2                          Simple DirectMedia Layer
     3 
     4                                   (SDL)
     5 
     6                                 Version 1.2
     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 Linux, Windows, Windows CE, BeOS, MacOS,
    16 Mac OS X, FreeBSD, NetBSD, OpenBSD, BSD/OS, Solaris, IRIX, and QNX.
    17 The code contains support for Dreamcast, Atari, AIX, OSF/Tru64,
    18 RISC OS, SymbianOS, and OS/2, but these are not officially supported.
    19 
    20 SDL is written in C, but works with C++ natively, and has bindings to
    21 several other languages, including Ada, C#, Eiffel, Erlang, Euphoria,
    22 Guile, Haskell, Java, Lisp, Lua, ML, Objective C, Pascal, Perl, PHP,
    23 Pike, Pliant, Python, Ruby, and Smalltalk.
    24 
    25 This library is distributed under GNU LGPL version 2, which can be
    26 found in the file  "COPYING".  This license allows you to use SDL
    27 freely in commercial programs as long as you link with the dynamic
    28 library.
    29 
    30 The best way to learn how to use SDL is to check out the header files in
    31 the "include" subdirectory and the programs in the "test" subdirectory.
    32 The header files and test programs are well commented and always up to date.
    33 More documentation is available in HTML format in "docs/index.html", and
    34 a documentation wiki is available online at:
    35 	http://www.libsdl.org/cgi/docwiki.cgi
    36 
    37 The test programs in the "test" subdirectory are in the public domain.
    38 
    39 Frequently asked questions are answered online:
    40 	http://www.libsdl.org/faq.php
    41 
    42 If you need help with the library, or just want to discuss SDL related
    43 issues, you can join the developers mailing list:
    44 	http://www.libsdl.org/mailing-list.php
    45 
    46 Enjoy!
    47 	Sam Lantinga				(slouken@libsdl.org)
    48