docs/README.md
changeset 9025 d09d4b578e77
parent 9023 276802355854
child 9048 e5d64ad7fdc5
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/docs/README.md	Tue Jul 29 08:04:15 2014 -0700
     1.3 @@ -0,0 +1,62 @@
     1.4 +Simple DirectMedia Layer {#mainpage}
     1.5 +========================
     1.6 +
     1.7 +                                  (SDL)
     1.8 +
     1.9 +                                Version 2.0
    1.10 +
    1.11 +---
    1.12 +http://www.libsdl.org/
    1.13 +
    1.14 +Simple DirectMedia Layer is a cross-platform development library designed
    1.15 +to provide low level access to audio, keyboard, mouse, joystick, and graphics
    1.16 +hardware via OpenGL and Direct3D. It is used by video playback software,
    1.17 +emulators, and popular games including Valve's award winning catalog
    1.18 +and many Humble Bundle games. 42
    1.19 +
    1.20 +SDL officially supports Windows, Mac OS X, Linux, iOS, and Android.
    1.21 +Support for other platforms may be found in the source code.
    1.22 +
    1.23 +SDL is written in C, works natively with C++, and there are bindings 
    1.24 +available for several other languages, including C# and Python.
    1.25 +
    1.26 +This library is distributed under the zlib license, which can be found
    1.27 +in the file "COPYING.txt".
    1.28 +
    1.29 +The best way to learn how to use SDL is to check out the header files in
    1.30 +the "include" subdirectory and the programs in the "test" subdirectory.
    1.31 +The header files and test programs are well commented and always up to date.
    1.32 +
    1.33 +More documentation and FAQs are available online at [the wiki](http://wiki.libsdl.org/)
    1.34 +
    1.35 +- [Android](README-android.md)
    1.36 +- [CMake](README-cmake.md)
    1.37 +- [DirectFB](README-directfb.md)
    1.38 +- [DynAPI](README-dynapi.md)
    1.39 +- [Gesture](README-gesture.md)
    1.40 +- [Mercurial](README-hg.md)
    1.41 +- [iOS](README-ios.md)
    1.42 +- [Linux](README-linux.md)
    1.43 +- [OS X](README-macosx.md)
    1.44 +- [Native Client](README-nacl.md)
    1.45 +- [Pandora](README-pandora.md)
    1.46 +- [Supported Platforms](README-platforms.md)
    1.47 +- [Porting information](README-porting.md)
    1.48 +- [PSP](README-psp.md)
    1.49 +- [Raspberry Pi](README-raspberrypi.md)
    1.50 +- [Touch](README-touch.md)
    1.51 +- [WinCE](README-wince.md)
    1.52 +- [Windows](README-windows.md)
    1.53 +- [WinRT](README-winrt.md)
    1.54 +
    1.55 +If you need help with the library, or just want to discuss SDL related
    1.56 +issues, you can join the [developers mailing list](http://www.libsdl.org/mailing-list.php)
    1.57 +
    1.58 +If you want to report bugs or contribute patches, please submit them to
    1.59 +[bugzilla](http://bugzilla.libsdl.org/)
    1.60 +
    1.61 +Enjoy!
    1.62 +
    1.63 +
    1.64 +Sam Lantinga <mailto:slouken@libsdl.org>
    1.65 +