SDL/doc
Gabriel Jacobo f982d08784 Rearrange documentation
1) Moves all READMEs to docs/
2) Renames them to *.md, adds some Markdown with the idea to add a lot more
3) Moves the doxyfile config to doc/ and makes it parse the headers at ../include as well as the md files in docs.
4) Skips SDL_opengl*.h headers from the docs
5) Minor fixes to doxyfile
2014-07-29 09:20:12 -03:00
..
README-SDL.md Rearrange documentation 2014-07-29 09:20:12 -03:00
README-android.md Rearrange documentation 2014-07-29 09:20:12 -03:00
README-cmake.md Rearrange documentation 2014-07-29 09:20:12 -03:00
README-directfb.md Rearrange documentation 2014-07-29 09:20:12 -03:00
README-dynapi.md Rearrange documentation 2014-07-29 09:20:12 -03:00
README-gesture.md Rearrange documentation 2014-07-29 09:20:12 -03:00
README-hg.md Rearrange documentation 2014-07-29 09:20:12 -03:00
README-ios.md Rearrange documentation 2014-07-29 09:20:12 -03:00
README-linux.md Rearrange documentation 2014-07-29 09:20:12 -03:00
README-macosx.md Rearrange documentation 2014-07-29 09:20:12 -03:00
README-nacl.md Rearrange documentation 2014-07-29 09:20:12 -03:00
README-pandora.md Rearrange documentation 2014-07-29 09:20:12 -03:00
README-platforms.md Rearrange documentation 2014-07-29 09:20:12 -03:00
README-porting.md Rearrange documentation 2014-07-29 09:20:12 -03:00
README-psp.md Rearrange documentation 2014-07-29 09:20:12 -03:00
README-raspberrypi.md Rearrange documentation 2014-07-29 09:20:12 -03:00
README-touch.md Rearrange documentation 2014-07-29 09:20:12 -03:00
README-wince.md Rearrange documentation 2014-07-29 09:20:12 -03:00
README-windows.md Rearrange documentation 2014-07-29 09:20:12 -03:00
README-winrt.md Rearrange documentation 2014-07-29 09:20:12 -03:00
README.md Rearrange documentation 2014-07-29 09:20:12 -03:00
doxyfile Rearrange documentation 2014-07-29 09:20:12 -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. 42

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 "COPYING.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 developers mailing list

If you want to report bugs or contribute patches, please submit them to bugzilla

Enjoy!

Sam Lantinga mailto:slouken@libsdl.org