mirrors/SDL
0
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2024-12-02 16:23:28 +08:00
Code Issues Packages Projects Releases Wiki Activity
0c7c4bfcf9
SDL/docs
History
Simon McVittie 0c7c4bfcf9 docs: Don't let Doxygen expand HOME environment variable 
Otherwise, the API documentation will encode the home directory of the
user or autobuilder that built SDL, instead of telling the user to use
the literal string $(HOME) as intended.

See also <https://github.com/doxygen/doxygen/issues/7073>.

Signed-off-by: Simon McVittie <smcv@debian.org>
2021-12-01 02:37:40 +03:00
..
doxyfile Fixed crash if initialization of EGL failed but was tried again later. 2015-06-21 17:33:46 +02:00
README-android.md Revert "Removed reference to ant project." 2021-07-07 13:30:48 -07:00
README-cmake.md CMake: tabs to spaces in new parts of README-cmake.md 2019-09-23 18:30:22 -04:00
README-directfb.md Converted README documentation to DOS text format 2016-10-07 17:46:58 -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 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-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 Updated iOS build instructions 2021-11-30 12:19:26 -08: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 updated linux dependencies for libXfixes-devel. 2021-11-12 15:55:50 +03:00
README-macos.md docs: Don't let Doxygen expand HOME environment variable 2021-12-01 02:37:40 +03:00
README-nacl.md Converted README documentation to DOS text format 2016-10-07 17:46:58 -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 (#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-psp.md PSP: links for setting up, compiling and running on PSP 2021-10-04 22:12:08 +02:00
README-raspberrypi.md Formatting fixes (purely cosmetic, fixes GitHub's rendering) 2021-09-07 07:29:40 -10: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-visualc.md update some copy 2021-02-15 08:35:13 -08:00
README-vita.md Update Docs 2021-09-10 19:49:47 -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 README-winrt.md: Cleaned up sample code 2021-08-03 21:52:47 -04:00
README.md minor update to docs/README.md 2021-11-12 20:55:02 +03: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 "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