README.txt
author Sam Lantinga <slouken@libsdl.org>
Tue, 06 Aug 2013 12:56:47 -0700
changeset 7579 efb0c78d4a48
parent 7359 96ac247b672e
child 7599 bd0c15431dc9
permissions -rw-r--r--
Added scancodes for F17, F18, F19 on a Mac keyboard
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
7222
2435b221d77d Renamed documentation files to .txt and converted them to DOS line endings so they would open properly on all systems.
Sam Lantinga <slouken@libsdl.org>
parents: 6987
diff changeset
     1
2435b221d77d Renamed documentation files to .txt and converted them to DOS line endings so they would open properly on all systems.
Sam Lantinga <slouken@libsdl.org>
parents: 6987
diff changeset
     2
                         Simple DirectMedia Layer
2435b221d77d Renamed documentation files to .txt and converted them to DOS line endings so they would open properly on all systems.
Sam Lantinga <slouken@libsdl.org>
parents: 6987
diff changeset
     3
2435b221d77d Renamed documentation files to .txt and converted them to DOS line endings so they would open properly on all systems.
Sam Lantinga <slouken@libsdl.org>
parents: 6987
diff changeset
     4
                                  (SDL)
2435b221d77d Renamed documentation files to .txt and converted them to DOS line endings so they would open properly on all systems.
Sam Lantinga <slouken@libsdl.org>
parents: 6987
diff changeset
     5
2435b221d77d Renamed documentation files to .txt and converted them to DOS line endings so they would open properly on all systems.
Sam Lantinga <slouken@libsdl.org>
parents: 6987
diff changeset
     6
                                Version 2.0
2435b221d77d Renamed documentation files to .txt and converted them to DOS line endings so they would open properly on all systems.
Sam Lantinga <slouken@libsdl.org>
parents: 6987
diff changeset
     7
2435b221d77d Renamed documentation files to .txt and converted them to DOS line endings so they would open properly on all systems.
Sam Lantinga <slouken@libsdl.org>
parents: 6987
diff changeset
     8
---
2435b221d77d Renamed documentation files to .txt and converted them to DOS line endings so they would open properly on all systems.
Sam Lantinga <slouken@libsdl.org>
parents: 6987
diff changeset
     9
http://www.libsdl.org/
2435b221d77d Renamed documentation files to .txt and converted them to DOS line endings so they would open properly on all systems.
Sam Lantinga <slouken@libsdl.org>
parents: 6987
diff changeset
    10
7359
96ac247b672e Updated the README to match the new website text
Sam Lantinga <slouken@libsdl.org>
parents: 7330
diff changeset
    11
Simple DirectMedia Layer is a cross-platform development library designed
96ac247b672e Updated the README to match the new website text
Sam Lantinga <slouken@libsdl.org>
parents: 7330
diff changeset
    12
to provide low level access to audio, keyboard, mouse, joystick, and graphics
96ac247b672e Updated the README to match the new website text
Sam Lantinga <slouken@libsdl.org>
parents: 7330
diff changeset
    13
hardware via OpenGL and DirectX. It is used by video playback software,
96ac247b672e Updated the README to match the new website text
Sam Lantinga <slouken@libsdl.org>
parents: 7330
diff changeset
    14
emulators, and popular games including Valve's award winning catalog
96ac247b672e Updated the README to match the new website text
Sam Lantinga <slouken@libsdl.org>
parents: 7330
diff changeset
    15
and many Humble Bundle games.
7222
2435b221d77d Renamed documentation files to .txt and converted them to DOS line endings so they would open properly on all systems.
Sam Lantinga <slouken@libsdl.org>
parents: 6987
diff changeset
    16
7359
96ac247b672e Updated the README to match the new website text
Sam Lantinga <slouken@libsdl.org>
parents: 7330
diff changeset
    17
The current version supports Windows, Mac OS X, Linux, iOS, and Android.
96ac247b672e Updated the README to match the new website text
Sam Lantinga <slouken@libsdl.org>
parents: 7330
diff changeset
    18
The code contains support for other operating systems but those are not
96ac247b672e Updated the README to match the new website text
Sam Lantinga <slouken@libsdl.org>
parents: 7330
diff changeset
    19
officially supported.
7222
2435b221d77d Renamed documentation files to .txt and converted them to DOS line endings so they would open properly on all systems.
Sam Lantinga <slouken@libsdl.org>
parents: 6987
diff changeset
    20
2435b221d77d Renamed documentation files to .txt and converted them to DOS line endings so they would open properly on all systems.
Sam Lantinga <slouken@libsdl.org>
parents: 6987
diff changeset
    21
SDL is written in C, but works with C++ natively, and has bindings to
7359
96ac247b672e Updated the README to match the new website text
Sam Lantinga <slouken@libsdl.org>
parents: 7330
diff changeset
    22
several other languages, including C#, Python and more in progress.
7222
2435b221d77d Renamed documentation files to .txt and converted them to DOS line endings so they would open properly on all systems.
Sam Lantinga <slouken@libsdl.org>
parents: 6987
diff changeset
    23
2435b221d77d Renamed documentation files to .txt and converted them to DOS line endings so they would open properly on all systems.
Sam Lantinga <slouken@libsdl.org>
parents: 6987
diff changeset
    24
This library is distributed under the zlib license, which can be found
7330
95a9e82b5414 Updated the name of the copyright file
Sam Lantinga <slouken@libsdl.org>
parents: 7241
diff changeset
    25
in the file "COPYING.txt".
7222
2435b221d77d Renamed documentation files to .txt and converted them to DOS line endings so they would open properly on all systems.
Sam Lantinga <slouken@libsdl.org>
parents: 6987
diff changeset
    26
2435b221d77d Renamed documentation files to .txt and converted them to DOS line endings so they would open properly on all systems.
Sam Lantinga <slouken@libsdl.org>
parents: 6987
diff changeset
    27
The best way to learn how to use SDL is to check out the header files in
2435b221d77d Renamed documentation files to .txt and converted them to DOS line endings so they would open properly on all systems.
Sam Lantinga <slouken@libsdl.org>
parents: 6987
diff changeset
    28
the "include" subdirectory and the programs in the "test" subdirectory.
2435b221d77d Renamed documentation files to .txt and converted them to DOS line endings so they would open properly on all systems.
Sam Lantinga <slouken@libsdl.org>
parents: 6987
diff changeset
    29
The header files and test programs are well commented and always up to date.
7241
28602f5ca96d Fixed recently deleted Ms in READMEs.
Philipp Wiesemann <philipp.wiesemann@arcor.de>
parents: 7222
diff changeset
    30
More documentation and FAQs are available online at:
7222
2435b221d77d Renamed documentation files to .txt and converted them to DOS line endings so they would open properly on all systems.
Sam Lantinga <slouken@libsdl.org>
parents: 6987
diff changeset
    31
	http://wiki.libsdl.org/
2435b221d77d Renamed documentation files to .txt and converted them to DOS line endings so they would open properly on all systems.
Sam Lantinga <slouken@libsdl.org>
parents: 6987
diff changeset
    32
2435b221d77d Renamed documentation files to .txt and converted them to DOS line endings so they would open properly on all systems.
Sam Lantinga <slouken@libsdl.org>
parents: 6987
diff changeset
    33
If you need help with the library, or just want to discuss SDL related
2435b221d77d Renamed documentation files to .txt and converted them to DOS line endings so they would open properly on all systems.
Sam Lantinga <slouken@libsdl.org>
parents: 6987
diff changeset
    34
issues, you can join the developers mailing list:
2435b221d77d Renamed documentation files to .txt and converted them to DOS line endings so they would open properly on all systems.
Sam Lantinga <slouken@libsdl.org>
parents: 6987
diff changeset
    35
	http://www.libsdl.org/mailing-list.php
2435b221d77d Renamed documentation files to .txt and converted them to DOS line endings so they would open properly on all systems.
Sam Lantinga <slouken@libsdl.org>
parents: 6987
diff changeset
    36
2435b221d77d Renamed documentation files to .txt and converted them to DOS line endings so they would open properly on all systems.
Sam Lantinga <slouken@libsdl.org>
parents: 6987
diff changeset
    37
Enjoy!
2435b221d77d Renamed documentation files to .txt and converted them to DOS line endings so they would open properly on all systems.
Sam Lantinga <slouken@libsdl.org>
parents: 6987
diff changeset
    38
	Sam Lantinga				(slouken@libsdl.org)
2435b221d77d Renamed documentation files to .txt and converted them to DOS line endings so they would open properly on all systems.
Sam Lantinga <slouken@libsdl.org>
parents: 6987
diff changeset
    39