SDL/docs
Pierre Wendling dcfa127fd4 N3DS: Document the SDL_GetBasePath behaviour. 2022-11-14 21:24:10 -08:00
..
CONTRIBUTING.md Add contributing guidelines. 2022-08-07 16:34:52 -07:00
README-android.md Update minimal required Android SDK version 2022-08-24 11:39:32 -07:00
README-cmake.md Expand CMake documentation a bit () 2022-08-09 13:05:03 -07:00
README-directfb.md Clean up formatting in README-directfb.md 2022-03-27 09:12:25 -07:00
README-dynapi.md README-dynapi.md: Google+ link is gone, remove it. 2021-08-03 22:15:04 -04:00
README-emscripten.md docs: Add notes about Emscripten audio quirks. 2022-10-28 16:08:23 -04:00
README-gdk.md Xbox GDKX support () 2022-07-01 13:59:14 -07: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 ()" 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 iOS: remove dead pre-iOS 8 codepaths. 2022-10-02 19:57:46 -07:00
README-kmsbsd.md KMSDRM on Dragonfly BSD doesn't work without being root 2021-05-12 09:26:23 -07:00
README-linux.md Update the list of required Ubuntu packages, and add Ubuntu 22.04 workflows 2022-07-30 13:07:54 -07: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 N3DS: Document the SDL_GetBasePath behaviour. 2022-11-14 21:24:10 -08:00
README-nacl.md Converted README documentation to DOS text format 2016-10-07 17:46:58 -07:00
README-ngage.md N-Gage port: add changes from code reviews, overall cleanup () 2022-05-11 09:31:34 -07:00
README-os2.md fixed typo: ervironment to environment 2021-11-22 11:35:40 +03:00
README-pandora.md Converted README documentation to DOS text format 2016-10-07 17:46:58 -07:00
README-platforms.md Revert "Update wiki.libsdl.org urls to libsdl-org/SDL/wiki ()" 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 Adding specific SDL_Hint for the dynamic VSYNC 2022-08-30 07:20:36 -04:00
README-psp.md Updating Readme-psp info 2022-02-02 08:36:39 -05:00
README-raspberrypi.md x11: Remove XVidMode and Xinerama support. 2022-04-26 23:17:13 -04:00
README-riscos.md docs: Add README-riscos.md 2021-10-30 21:25:01 -07: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 Remove URLs from markdown headers in README-visualc.md 2022-03-27 09:12:25 -07:00
README-vita.md Vita: fix readme 2022-03-31 06:02:50 -07:00
README-wince.md Converted README documentation to DOS text format 2016-10-07 17:46:58 -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 README-winrt.md: Updates for newer build details. 2022-08-09 10:09:54 -04:00
README.md Update README.md 2022-09-28 10:17:39 -04:00
doxyfile docs/release_checklist.md: Document how/where to bump version numbers 2022-05-04 09:55:35 -07: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