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/>.


                        Installing MLV
                        ==============


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

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

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

REQUIREMENTS :
-------------

To compile the library require:
- the classic building tools 
  ( pkg-config, make, gcc )   
- glib2
- libxml2
- SDL 1.2
- SDL_image
- SDL_mixer
- SDL_gfx
- SDL_ttf
- doxygen

BUILDING AND INSTALLING FROM TARBALL DISTRIBUTIONS :
___________________________________________________

Let INSTALL_DIRECTORY be the directory where you want to install the MLV 
library.
To compile and install the MLV library, you just have to type :

./configure --prefix=INSTALL_DIRECTORY
make
make install

BUILDING AND INSTALLING FROM REPOSITORY SOURCE : 
________________________________________________

To build from the repository source, you will require additional building 
tools:
 - m4
 - autoconf
 - automake
 - libtool 

Let INSTALL_DIRECTORY be the directory where you want to install the MLV
library.
To compile and install the MLV library, you just have to type :

./autogen.sh
./configure --prefix=INSTALL_DIRECTORY
make  
make install

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.

