doc/README.md
author Gabriel Jacobo <gabomdq@gmail.com>
Tue, 29 Jul 2014 09:20:12 -0300
changeset 9023 276802355854
permissions -rw-r--r--
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
     1 Simple DirectMedia Layer {#mainpage}
     2 ========================
     3 
     4                                   (SDL)
     5 
     6                                 Version 2.0
     7 
     8 ---
     9 http://www.libsdl.org/
    10 
    11 Simple DirectMedia Layer is a cross-platform development library designed
    12 to provide low level access to audio, keyboard, mouse, joystick, and graphics
    13 hardware via OpenGL and Direct3D. It is used by video playback software,
    14 emulators, and popular games including Valve's award winning catalog
    15 and many Humble Bundle games. 42
    16 
    17 SDL officially supports Windows, Mac OS X, Linux, iOS, and Android.
    18 Support for other platforms may be found in the source code.
    19 
    20 SDL is written in C, works natively with C++, and there are bindings 
    21 available for several other languages, including C# and Python.
    22 
    23 This library is distributed under the zlib license, which can be found
    24 in the file "COPYING.txt".
    25 
    26 The best way to learn how to use SDL is to check out the header files in
    27 the "include" subdirectory and the programs in the "test" subdirectory.
    28 The header files and test programs are well commented and always up to date.
    29 
    30 More documentation and FAQs are available online at [the wiki](http://wiki.libsdl.org/)
    31 
    32 - [Android](README-android.md)
    33 - [CMake](README-cmake.md)
    34 - [DirectFB](README-directfb.md)
    35 - [DynAPI](README-dynapi.md)
    36 - [Gesture](README-gesture.md)
    37 - [Mercurial](README-hg.md)
    38 - [iOS](README-ios.md)
    39 - [Linux](README-linux.md)
    40 - [OS X](README-macosx.md)
    41 - [Native Client](README-nacl.md)
    42 - [Pandora](README-pandora.md)
    43 - [Supported Platforms](README-platforms.md)
    44 - [Porting information](README-porting.md)
    45 - [PSP](README-psp.md)
    46 - [Raspberry Pi](README-raspberrypi.md)
    47 - [Touch](README-touch.md)
    48 - [WinCE](README-wince.md)
    49 - [Windows](README-windows.md)
    50 - [WinRT](README-winrt.md)
    51 
    52 If you need help with the library, or just want to discuss SDL related
    53 issues, you can join the [developers mailing list](http://www.libsdl.org/mailing-list.php)
    54 
    55 If you want to report bugs or contribute patches, please submit them to
    56 [bugzilla](http://bugzilla.libsdl.org/)
    57 
    58 Enjoy!
    59 
    60 
    61 Sam Lantinga <mailto:slouken@libsdl.org>
    62