-----------------------------------------------------------------------
MySDL - Source Code Readme
-----------------------------------------------------------------------

This source code is released under the GNU General Public License (GPL). See the gpl.txt file that came with this distribution for a copy of the license.

-----------------------------------------------------------------------
Requirements:
-----------------------------------------------------------------------

To build MySDL, you need the following tools and libraries:

* SCons (http://www.scons.org)
* OpenGL with GLU
* SDL (http://www.libsdl.org)
* SDL_image (http://www.libsdl.org/projects/SDL_image/)
* expat (http://expat.sourceforge.net/)
* OpenAL (http://www.openal.org)
* libogg & libvorbis (http://xiph.org/vorbis/)

On a Linux system, you need a working g++ compiler installation. On a Windows system you need the mingw compiler.

-----------------------------------------------------------------------
Building the library:
-----------------------------------------------------------------------

To build MySDL for the local system, execute:

  scons dist=1

Leave out "dist=1" in this and all subsequent build commands to build a development version. The development version contains debugger (gdb) symbols and logging for all debug levels. The standard (non-development) version uses code optimisation and only provides logging for debug levels no lower than "info". When you compile code using the MySDL library, the debug level of both projects should be the same.

After a succesful build process, you will find a usable distribution in the dist directory.

To build MySDL for a Windows system using a Linux system (cross-compiling), execute:

  scons win32=1 dist=1

This will create a Windows distribution in the dist/win32 directory. A Windows installation (or emulator) is needed to execute programs using this library.

-----------------------------------------------------------------------
Copyright (C) 2006 Marian Schedenig (marian@musgit.com)
