You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
sdl/docs
Klay 71f479b4aa Fix a broken link inside README-cmake.md that's meant to send to README-linux.md
also made said link more consistent with other links by adding .md suffix
3 weeks ago
..
INTRO-androidstudio.md Added https://github.com/Ravbug/sdl3-sample as a more complete Android example 5 months ago
INTRO-cmake.md Added MinGW Intro readme, touched up CMake and Visual Studio readmes. (#12485) 4 months ago
INTRO-emscripten.md Tweaked emscripten introduction 5 months ago
INTRO-mingw.md Fixup the mingw readme cmakelists 4 months ago
INTRO-visualstudio.md Added MinGW Intro readme, touched up CMake and Visual Studio readmes. (#12485) 4 months ago
INTRO-xcode.md Added INTRO-xcode.md 6 months ago
README-android.md Sync SDL3 wiki -> header 3 months ago
README-bsd.md Updated README-platforms.md 5 months ago
README-cmake.md Fix a broken link inside README-cmake.md that's meant to send to README-linux.md 3 weeks ago
README-contributing.md Minor readability improvement for README-contributing.md 6 months ago
README-documentation-rules.md README-documentation-rules: Add a note about being UTF-8 only! 1 month ago
README-dynapi.md Removed SDL_bool in favor of plain bool 9 months ago
README-emscripten.md Sync SDL3 wiki -> header 2 months ago
README-gdk.md Rename functions in SDL_system.h to match SDL 3.0 naming convention 12 months ago
README-haiku.md Updated README-platforms.md 5 months ago
README-highdpi.md More clarification for high DPI support 3 months ago
README-ios.md Updates SDL_SetEventFilter code snippet to SDL3 3 months ago
README-kmsbsd.md docs: Convert everything to Unix-style endlines. 2 years ago
README-linux.md Fix Markdown typo in Arch Linux dependencies docs 3 weeks ago
README-macos.md Bumped deployment requirements for Apple platforms 5 months ago
README-main-functions.md docs/README-main-functions.md: reformatted Best Practices section. 7 months ago
README-migration.md android: reduce visiblity as much as possible 3 months ago
README-n3ds.md docs: Convert everything to Unix-style endlines. 2 years ago
README-ngage.md README-ngage.md: Really actually got all the non-UTF-8 characters this time! 1 month ago
README-platforms.md Sync SDL3 wiki -> header 1 month ago
README-porting.md winrt: Removed WinRT/Windows Phone/UWP support. 10 months ago
README-ps2.md JANITORIAL: Fix typos in comments in various files (#10058) 1 year ago
README-ps4.md Updated README-platforms.md 5 months ago
README-ps5.md Updated README-platforms.md 5 months ago
README-psp.md Sync SDL3 wiki -> header 3 months ago
README-riscos.md docs: Convert everything to Unix-style endlines. 2 years ago
README-steamos.md Updated README-platforms.md 5 months ago
README-strings.md Removed temporary memory from the API 11 months ago
README-switch.md Updated README-platforms.md 5 months ago
README-touch.md Sync SDL3 wiki -> header 6 months ago
README-versions.md Updated version documentation to match SDL 3.x practice 3 months ago
README-vita.md Sync SDL3 wiki -> header 6 months ago
README-wayland.md Add progress bar support for Linux 2 months ago
README-windows.md minor update to mingw-w64 build instructions. 6 months ago
README.md Updated README-platforms.md 5 months ago
doxyfile Don't automatically free temporary memory, let the application call SDL_FreeTemporaryMemory() when it's ready. 11 months ago
hello.c Remove newlines from log messages 5 months ago
release_checklist.md Added a note to tag the wiki when doing feature releases 3 months ago

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