SDL/docs
Sam Lantinga a635a485bc Re-added WinRT support until we're sure that it's no longer being used 2022-11-23 10:41:43 -08:00
..
CONTRIBUTING.md Add contributing guidelines. 2022-08-07 16:34:52 -07:00
README-android.md First pass at changing SDL 2.0 to SDL 3.0 2022-11-21 20:28:58 -08:00
README-cmake.md First pass at changing SDL 2.0 to SDL 3.0 2022-11-21 20:28:58 -08:00
README-dynapi.md First pass at changing SDL 2.0 to SDL 3.0 2022-11-21 20:28:58 -08:00
README-emscripten.md First pass at changing SDL 2.0 to SDL 3.0 2022-11-21 20:28:58 -08:00
README-gdk.md First pass at changing SDL 2.0 to SDL 3.0 2022-11-21 20:28:58 -08: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-git.md Revert "Update wiki.libsdl.org urls to libsdl-org/SDL/wiki (#4069)" 2021-04-01 12:15:28 -04:00
README-hg.md Deprecate SDL_GetRevisionNumber and update things for git instead of hg. 2021-02-12 14:31:38 -05:00
README-ios.md First pass at changing SDL 2.0 to SDL 3.0 2022-11-21 20:28:58 -08:00
README-kmsbsd.md First pass at changing SDL 2.0 to SDL 3.0 2022-11-21 20:28:58 -08:00
README-linux.md reverted jack audio backend removal. 2022-11-23 06:50:20 +03:00
README-macos.md Updated minimum OS targets on Apple platforms to match supported platforms using Xcode 13 2022-07-26 11:36:01 -07:00
README-n3ds.md First pass at changing SDL 2.0 to SDL 3.0 2022-11-21 20:28:58 -08:00
README-ngage.md First pass at changing SDL 2.0 to SDL 3.0 2022-11-21 20:28:58 -08:00
README-platforms.md Revert "Update wiki.libsdl.org urls to libsdl-org/SDL/wiki (#4069)" 2021-04-01 12:15:28 -04:00
README-porting.md docs: Replace references to configure.in with configure.ac 2019-03-27 20:58:33 +11:00
README-ps2.md First pass at changing SDL 2.0 to SDL 3.0 2022-11-21 20:28:58 -08:00
README-psp.md First pass at changing SDL 2.0 to SDL 3.0 2022-11-21 20:28:58 -08:00
README-raspberrypi.md First pass at changing SDL 2.0 to SDL 3.0 2022-11-21 20:28:58 -08:00
README-riscos.md Update README-riscos.md to reflect that atomic functions have been fixed 2022-11-22 08:32:18 -08:00
README-touch.md Converted README documentation to DOS text format 2016-10-07 17:46:58 -07:00
README-versions.md docs: Document new versioning scheme 2022-05-04 09:55:35 -07:00
README-visualc.md First pass at changing SDL 2.0 to SDL 3.0 2022-11-21 20:28:58 -08:00
README-vita.md Vita: fix readme 2022-03-31 06:02:50 -07:00
README-windows.md README-windows: Notes on building with Visual Studio/LLVM. 2022-03-26 08:55:26 -04:00
README-winrt.md Re-added WinRT support until we're sure that it's no longer being used 2022-11-23 10:41:43 -08:00
README.md Re-added WinRT support until we're sure that it's no longer being used 2022-11-23 10:41:43 -08:00
doxyfile reverted opengles removal. 2022-11-23 18:50:02 +03:00
release_checklist.md Added a note to update the website after a stable release 2022-10-08 09:41:10 -07:00

README.md

Simple DirectMedia Layer

https://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, macOS, 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 "LICENSE.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 SDL Discourse, which can be used as a web forum or a mailing list, at your preference.

If you want to report bugs or contribute patches, please submit them to our bug tracker

Enjoy!

Sam Lantinga mailto:slouken@libsdl.org