SDL/docs
Ryan C. Gordon b43f427fa6 README-ios: added a note about enabling hidapi. 2018-10-29 15:51:38 -04:00
..
README-android.md Updated Android project files and documentation 2018-10-28 10:31:06 -07:00
README-cmake.md Converted README documentation to DOS text format 2016-10-07 17:46:58 -07:00
README-directfb.md Converted README documentation to DOS text format 2016-10-07 17:46:58 -07:00
README-dynapi.md Fixed typos (thanks Martin!) 2017-12-04 20:21:52 -08:00
README-emscripten.md Emscripten: Simplified option name in build script and README. 2017-04-02 21:33:24 +02:00
README-gesture.md Fixed crash if initialization of EGL failed but was tried again later. 2015-06-21 17:33:46 +02:00
README-hg.md README-hg.md: Updated main Mercurial website. 2017-04-01 00:17:15 -04:00
README-ios.md README-ios: added a note about enabling hidapi. 2018-10-29 15:51:38 -04:00
README-linux.md Updated documentation to note that libvulkan-dev is no longer needed 2017-09-09 07:45:31 -07:00
README-macosx.md We don't need the VULKAN_SDK to build SDL with Vulkan support anymore 2017-08-28 19:30:59 -07:00
README-nacl.md Converted README documentation to DOS text format 2016-10-07 17:46:58 -07:00
README-pandora.md Converted README documentation to DOS text format 2016-10-07 17:46:58 -07:00
README-platforms.md Converted README documentation to DOS text format 2016-10-07 17:46:58 -07:00
README-porting.md Added missing path in porting README. 2017-05-13 23:01:04 +02:00
README-psp.md Converted README documentation to DOS text format 2016-10-07 17:46:58 -07:00
README-raspberrypi.md audio: Added ARM NEON versions of audio converters. 2018-05-16 02:03:06 -04:00
README-touch.md Converted README documentation to DOS text format 2016-10-07 17:46:58 -07:00
README-wince.md Converted README documentation to DOS text format 2016-10-07 17:46:58 -07:00
README-windows.md Be clear that disabling Vulkan surface support disables the entire SDL Vulkan integration 2017-08-28 00:11:38 -07:00
README-winrt.md audio: Port WASAPI to WinRT, remove XAudio2 backend. 2017-12-06 12:24:32 -05:00
README.md Changed Bugzilla link in README.md to HTTPS like in BUGS.txt. 2017-01-14 21:35:18 +01:00
doxyfile Fixed crash if initialization of EGL failed but was tried again later. 2015-06-21 17:33:46 +02:00

README.md

Simple DirectMedia Layer

                              (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.

SDL officially supports Windows, Mac OS X, Linux, iOS, and Android. 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 in the file "COPYING.txt".

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

If you need help with the library, or just want to discuss SDL related issues, you can join the developers mailing list

If you want to report bugs or contribute patches, please submit them to bugzilla

Enjoy!

Sam Lantinga mailto:slouken@libsdl.org