This file is part of the MLV Library.

Copyright (C) 2010 2011 2012 Adrien Boussicault, Marc Zipstein

This library is free software: you can redistribute it and/or modify it under 
the terms of the GNU General Public License as published by the Free Software 
Foundation, either version 3 of the License, or (at your option) any later 
version.

This library is distributed in the hope that it will be useful, but WITHOUT 
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more 
details.

You should have received a copy of the GNU General Public License along with 
this Library.  If not, see <http://www.gnu.org/licenses/>.


                               MLV Library
                               ===========

(MLV = Marne-La-Vallee)

DESCRIPTION :
_____________

The mlv library is a simplified multimedia libary.
The library is perfect for beginners in C programming who
want to use graphic and sound effects.
The library permit to:
 - draw figures, text and boxed text,
 - display images,
 - plays musics,
 - get Keyboard and mouse event
 - get informations by input boxes
This tools is a simplified interface of the SDL libraries.
If you are not a beginner, we recommend you to use the 
SDL libraries (sdl, sdl-gfx, sdl-sound, sdl-ttf) instead of
the mlv library.
The mlv library can be compiled for GNU/Linux, Macintosh 
and windows.
This package provide all the developpement infrastructure
of the mlv library.

SUPPORTED OPERATING SYSTEMS :
-----------------------------

The MLV library works on :
 - GNU/Linux
 - Windows XP/Seven
 - MacOS X

The MLV library doesn't work on :
 - Windows Vista

DOCUMENTATION :
---------------

More detailed documentation is generated by doxygen.
This documentation is build during the compilation process and can be founded :
 - in the build directory : ./doc/index.html
 - in the installation directory : INSTALL_DIRECTORY/share/doc/mlv/
This documentation contains more informations :
 - to compile MLV for different Opérating Systems (GNU/Linux, Windows, MacOsX)
 - to create some distribution packages (rpm, debian, CodeBlock, etc ...)
This documentation contains the complete API of the MLV library.

BUILDING AND INSTALLING :
_________________________

Please read the INSTALL file.