SDL/docs
Sam Lantinga 4b429b9fa7 Updated README-platforms.md
Also added platform specific README files
2025-01-16 16:21:18 -08:00
..
INTRO-androidstudio.md Added https://github.com/Ravbug/sdl3-sample as a more complete Android example 2025-01-14 12:22:00 -08:00
INTRO-cmake.md Updated README-cmake.md with build instructions for several platforms 2025-01-14 11:15:34 -08:00
INTRO-emscripten.md Added INTRO-emscripten.md 2025-01-13 16:42:50 -08:00
INTRO-visualstudio.md Added INTRO-visualstudio.md 2025-01-13 16:42:50 -08:00
INTRO-xcode.md Added INTRO-xcode.md 2025-01-13 16:42:50 -08:00
README-android.md Revert "Separate android initialization from Activity (#11891)" 2025-01-10 15:27:08 -08:00
README-bsd.md Updated README-platforms.md 2025-01-16 16:21:18 -08:00
README-cmake.md Updated README-platforms.md 2025-01-16 16:21:18 -08:00
README-contributing.md Minor readability improvement for README-contributing.md 2025-01-13 16:42:50 -08:00
README-documentation-rules.md README-documentation-rules.md: Mention not listing types in param/returns docs. 2024-11-20 23:59:24 -05:00
README-dynapi.md
README-emscripten.md Added INTRO-emscripten.md 2025-01-13 16:42:50 -08:00
README-gdk.md
README-haiku.md Updated README-platforms.md 2025-01-16 16:21:18 -08:00
README-highdpi.md
README-ios.md Bumped deployment requirements for Apple platforms 2025-01-14 12:03:07 -08:00
README-kmsbsd.md
README-linux.md asyncio: Added Linux io_uring support. 2024-12-03 17:32:20 -05:00
README-macos.md Bumped deployment requirements for Apple platforms 2025-01-14 12:03:07 -08:00
README-main-functions.md docs/README-main-functions.md: reformatted Best Practices section. 2024-11-28 00:19:55 -05:00
README-migration.md README-migration: note SDL2 brightness/gamma ramp APIs that have been removed. 2025-01-12 04:35:56 -05:00
README-n3ds.md
README-ngage.md ngage: Remove Nokia N-Gage support. 2024-12-11 13:29:43 -05:00
README-platforms.md Updated README-platforms.md 2025-01-16 16:21:18 -08:00
README-porting.md
README-ps2.md
README-ps4.md Updated README-platforms.md 2025-01-16 16:21:18 -08:00
README-ps5.md Updated README-platforms.md 2025-01-16 16:21:18 -08:00
README-psp.md
README-riscos.md
README-steamos.md Updated README-platforms.md 2025-01-16 16:21:18 -08:00
README-strings.md
README-switch.md Updated README-platforms.md 2025-01-16 16:21:18 -08:00
README-touch.md Sync SDL3 wiki -> header 2024-12-17 07:29:13 +00:00
README-versions.md
README-vita.md Sync SDL3 wiki -> header 2025-01-09 20:15:17 +00:00
README-wayland.md
README-windows.md minor update to mingw-w64 build instructions. 2025-01-14 05:04:24 +03:00
README.md Updated README-platforms.md 2025-01-16 16:21:18 -08:00
doxyfile
hello.c Added INTRO-emscripten.md 2025-01-13 16:42:50 -08:00
release_checklist.md Added a reminder to sign the source archives when creating a release 2024-12-07 11:50:42 -08: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. 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, Android, Xbox, PlayStation 4/5, Nintendo Switch, and many other platforms.

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

Information on building SDL with CMake is available in README-cmake.md

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 "examples" subdirectory. The header files and test programs are well commented and always up to date.

Information on reporting bugs and contributing is available in README-contributing.md

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