annotate README @ 1626:a80e1e0880b8

Fixed bug #176 [I'm fixing this for the public headers, but I'm not going to bother for the SDL library code (yet)] To clarify: Normaly, GCC (or, to be precise, the preprocessor) will ignore this, and compile the code happily. However, one can specify -Wundef to get a warning about this. One can probably argue whether to consider this a bug or not; but I think that (a) from a semantic point of view, using "#if FOO" when FOO is not defined is strange, and (b) since it is possible to trigger a warning about this, and a trivial fix exists, it should be corrected. I can think of two alternative patches, BTW: 1) Simply use #define HAVE_FOO 0, instead of not defining HAVE_FOO at all 2) Change #if HAVE_FOO to #if HAVE_FOO+0 which always does the right thing. But I think I still prefer the attached patch :-).
author Sam Lantinga <slouken@libsdl.org>
date Thu, 13 Apr 2006 13:38:40 +0000
parents f12379c41042
children 14717b52abc0
rev   line source
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
1
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
2 Simple DirectMedia Layer
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
3
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
4 (SDL)
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
5
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
6 Version 1.2
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
7
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
8 ---
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
9 http://www.libsdl.org/
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
10
602
a24bd700f92e *** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents: 579
diff changeset
11 This is the Simple DirectMedia Layer, a general API that provides low
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
12 level access to audio, keyboard, mouse, joystick, 3D hardware via OpenGL,
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
13 and 2D framebuffer across multiple platforms.
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
14
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
15 SDL is written in C, but works with C++ natively, and has bindings to
579
70fa3e489399 Added some language bindings to the README
Sam Lantinga <slouken@libsdl.org>
parents: 578
diff changeset
16 several other languages, including Ada, C#, Eiffel, Java, Lua, ML,
1349
3f395c825b14 *** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents: 1276
diff changeset
17 Objective C, Pascal, Perl, PHP, Pike, Python, and Ruby.
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
18
1621
f12379c41042 Fixes bug #195:
Sam Lantinga <slouken@libsdl.org>
parents: 1349
diff changeset
19 The current version supports Linux, Windows, BeOS, MacOS, Mac OS X,
702
61b7f5eed0e8 QNX is now officially supported! Thanks to Mike Gorchak!
Sam Lantinga <slouken@libsdl.org>
parents: 630
diff changeset
20 FreeBSD, OpenBSD, BSD/OS, Solaris, IRIX, and QNX. The code contains
61b7f5eed0e8 QNX is now officially supported! Thanks to Mike Gorchak!
Sam Lantinga <slouken@libsdl.org>
parents: 630
diff changeset
21 support for Windows CE, AmigaOS, Dreamcast, Atari, NetBSD, AIX, OSF/Tru64,
1276
ca3718c215af Wacky! :)
Sam Lantinga <slouken@libsdl.org>
parents: 702
diff changeset
22 RISC OS, SymbianOS, and OS/2, but these are not officially supported.
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
23
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
24 This library is distributed under GNU LGPL version 2, which can be
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
25 found in the file "COPYING". This license allows you to use SDL
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
26 freely in commercial programs as long as you link with the dynamic
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
27 library.
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
28
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
29 The best way to learn how to use SDL is to check out the header files in
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
30 the "include" subdirectory and the programs in the "test" subdirectory.
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
31 The header files and test programs are well commented and always up to date.
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
32 More documentation is available in HTML format in "./docs/index.html"
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
33
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
34 The test programs in the "test" subdirectory are in the public domain.
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
35
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
36 Frequently asked questions are answered online:
369
e405cf8bf580 *** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents: 362
diff changeset
37 http://www.libsdl.org/faq.php
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
38
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
39 If you need help with the library, or just want to discuss SDL related
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
40 issues, you can join the developers mailing list:
369
e405cf8bf580 *** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents: 362
diff changeset
41 http://www.libsdl.org/mailing-list.php
0
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
42
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
43 Enjoy!
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
44 Sam Lantinga (slouken@libsdl.org)
74212992fb08 Initial revision
Sam Lantinga <slouken@lokigames.com>
parents:
diff changeset
45