Skip to content
Snippets Groups Projects
README.md 2.19 KiB
Newer Older
Alam Ed Arias's avatar
Alam Ed Arias committed
Simple DirectMedia Layer {#mainpage}
========================

                                  (SDL)

                                Version 2.0

---
http://www.libsdl.org/

Simple DirectMedia Layer is a cross-platform development library designed
to provide low level access to audio, keyboard, mouse, joystick, and graphics
hardware via OpenGL and Direct3D. It is used by video playback software,
emulators, and popular games including Valve's award winning catalog
and many Humble Bundle games.

James R.'s avatar
James R. committed
SDL officially supports Windows, macOS, Linux, iOS, and Android.
Alam Ed Arias's avatar
Alam Ed Arias committed
Support for other platforms may be found in the source code.

SDL is written in C, works natively with C++, and there are bindings 
available for several other languages, including C# and Python.

This library is distributed under the zlib license, which can be found
James R.'s avatar
James R. committed
in the file "LICENSE.txt".
Alam Ed Arias's avatar
Alam Ed Arias committed

The best way to learn how to use SDL is to check out the header files in
the "include" subdirectory and the programs in the "test" subdirectory.
The header files and test programs are well commented and always up to date.

More documentation and FAQs are available online at [the wiki](http://wiki.libsdl.org/)

- [Android](README-android.md)
- [CMake](README-cmake.md)
- [DirectFB](README-directfb.md)
- [DynAPI](README-dynapi.md)
- [Emscripten](README-emscripten.md)
- [Gesture](README-gesture.md)
James R.'s avatar
James R. committed
- [Git](README-git.md)
Alam Ed Arias's avatar
Alam Ed Arias committed
- [iOS](README-ios.md)
- [Linux](README-linux.md)
James R.'s avatar
James R. committed
- [macOS](README-macos.md)
- [OS/2](README-os2.md)
Alam Ed Arias's avatar
Alam Ed Arias committed
- [Native Client](README-nacl.md)
- [Pandora](README-pandora.md)
- [Supported Platforms](README-platforms.md)
- [Porting information](README-porting.md)
- [PSP](README-psp.md)
- [Raspberry Pi](README-raspberrypi.md)
- [Touch](README-touch.md)
- [WinCE](README-wince.md)
- [Windows](README-windows.md)
- [WinRT](README-winrt.md)
James R.'s avatar
James R. committed
- [PSVita](README-vita.md)
Alam Ed Arias's avatar
Alam Ed Arias committed

If you need help with the library, or just want to discuss SDL related
James R.'s avatar
James R. committed
issues, you can join the [SDL Discourse](https://discourse.libsdl.org/),
which can be used as a web forum or a mailing list, at your preference.
Alam Ed Arias's avatar
Alam Ed Arias committed

If you want to report bugs or contribute patches, please submit them to
James R.'s avatar
James R. committed
[our bug tracker](https://github.com/libsdl-org/SDL/issues)
Alam Ed Arias's avatar
Alam Ed Arias committed

Enjoy!


Sam Lantinga <mailto:slouken@libsdl.org>