docs/README.md
author Ryan C. Gordon <icculus@icculus.org>
Thu, 19 Feb 2015 23:52:10 -0500
changeset 9370 795d4866e4db
parent 9302 2ddb65f75084
child 10486 5bf595c48fd4
permissions -rw-r--r--
Mac OS X: Better way to stop duplicate joystick reports (thanks, Kyungdahm!).

Fixes Bugzilla #2822.
gabomdq@9023
     1
Simple DirectMedia Layer {#mainpage}
gabomdq@9023
     2
========================
gabomdq@9023
     3
gabomdq@9023
     4
                                  (SDL)
gabomdq@9023
     5
gabomdq@9023
     6
                                Version 2.0
gabomdq@9023
     7
gabomdq@9023
     8
---
gabomdq@9023
     9
http://www.libsdl.org/
gabomdq@9023
    10
gabomdq@9023
    11
Simple DirectMedia Layer is a cross-platform development library designed
gabomdq@9023
    12
to provide low level access to audio, keyboard, mouse, joystick, and graphics
gabomdq@9023
    13
hardware via OpenGL and Direct3D. It is used by video playback software,
gabomdq@9023
    14
emulators, and popular games including Valve's award winning catalog
philipp@9048
    15
and many Humble Bundle games.
gabomdq@9023
    16
gabomdq@9023
    17
SDL officially supports Windows, Mac OS X, Linux, iOS, and Android.
gabomdq@9023
    18
Support for other platforms may be found in the source code.
gabomdq@9023
    19
gabomdq@9023
    20
SDL is written in C, works natively with C++, and there are bindings 
gabomdq@9023
    21
available for several other languages, including C# and Python.
gabomdq@9023
    22
gabomdq@9023
    23
This library is distributed under the zlib license, which can be found
gabomdq@9023
    24
in the file "COPYING.txt".
gabomdq@9023
    25
gabomdq@9023
    26
The best way to learn how to use SDL is to check out the header files in
gabomdq@9023
    27
the "include" subdirectory and the programs in the "test" subdirectory.
gabomdq@9023
    28
The header files and test programs are well commented and always up to date.
gabomdq@9023
    29
gabomdq@9023
    30
More documentation and FAQs are available online at [the wiki](http://wiki.libsdl.org/)
gabomdq@9023
    31
gabomdq@9023
    32
- [Android](README-android.md)
gabomdq@9023
    33
- [CMake](README-cmake.md)
gabomdq@9023
    34
- [DirectFB](README-directfb.md)
gabomdq@9023
    35
- [DynAPI](README-dynapi.md)
philipp@9302
    36
- [Emscripten](README-emscripten.md)
gabomdq@9023
    37
- [Gesture](README-gesture.md)
gabomdq@9023
    38
- [Mercurial](README-hg.md)
gabomdq@9023
    39
- [iOS](README-ios.md)
gabomdq@9023
    40
- [Linux](README-linux.md)
gabomdq@9023
    41
- [OS X](README-macosx.md)
gabomdq@9023
    42
- [Native Client](README-nacl.md)
gabomdq@9023
    43
- [Pandora](README-pandora.md)
gabomdq@9023
    44
- [Supported Platforms](README-platforms.md)
gabomdq@9023
    45
- [Porting information](README-porting.md)
gabomdq@9023
    46
- [PSP](README-psp.md)
gabomdq@9023
    47
- [Raspberry Pi](README-raspberrypi.md)
gabomdq@9023
    48
- [Touch](README-touch.md)
gabomdq@9023
    49
- [WinCE](README-wince.md)
gabomdq@9023
    50
- [Windows](README-windows.md)
gabomdq@9023
    51
- [WinRT](README-winrt.md)
gabomdq@9023
    52
gabomdq@9023
    53
If you need help with the library, or just want to discuss SDL related
gabomdq@9023
    54
issues, you can join the [developers mailing list](http://www.libsdl.org/mailing-list.php)
gabomdq@9023
    55
gabomdq@9023
    56
If you want to report bugs or contribute patches, please submit them to
gabomdq@9023
    57
[bugzilla](http://bugzilla.libsdl.org/)
gabomdq@9023
    58
gabomdq@9023
    59
Enjoy!
gabomdq@9023
    60
gabomdq@9023
    61
gabomdq@9023
    62
Sam Lantinga <mailto:slouken@libsdl.org>
gabomdq@9023
    63