If you find any bugs use the Nevrax Bug Tracking System :

   <URL:/bugs/>

If you need any help contact us on the NeL mailing-list :

   <URL:/mail/>


Requirements
============

   The NeL library need the following libraries :

      - STLPort 4.0           <URL:http://www.stlport.org/>
      - FreeType 2            <URL:http://www.freetype.org/>

   On a GNU/Linux platform you will need the following libraries and
   softwares :

      - Mesa           <URL:http://www.mesa3d.org/>
      - Autoconf       <URL:http://www.gnu.org/software/autoconf/autoconf.html>
      - Automake       <URL:http://www.gnu.org/software/automake/automake.html>
      - Libtool        <URL:http://www.gnu.org/software/libtool/libtool.html>
      - Lex / Flex     <URL:http://www.gnu.org/software/flex/flex.html>
      - Yacc / Bison   <URL:http://www.gnu.org/software/bison/bison.html>

   Most of these softwares should be already installed on your system or
   provided on your installation disk. 


Compilation
===========

   1. Windows compilation
   ----------------------

      The compilation on Windows has been done only with Visual C++ 6.0 SP4.

      Set up Visual C++ to find the STLPort and FreeType libraries. This
      is done in the [Tools -> Options -> Directories] menu :

         - Add the STLPort include directory to the "Library Files" category.
           ex: D:/stlport-4.0/stlport

         - Add the STLPort library directory to the "Library Files" category.
           ex: D:/stlport-4.0/lib

         - Add the FreeType include directory to the "Include Files" category.
           ex: D:/freetype-2.0/include

         - Add the FreeType library directory to the "Library Files" category.
           ex: D:/freetype-2.0/obj

      Open the workspace file "nel.dsw" (in the menu [File -> Workspace]).

      Setup Visual C++ to find the NeL include and library files :

         - Add the NEL include directory to the "Library Files" category.
           ex: D:/test/code/nel/include

         - Add the STLPort library directory to the "Library Files" category.
           ex: D:/test/code/nel/lib


   2. GNU/Linux compilation
   ------------------------

      The compilation on GNU/Linux has been done only on RedHat 6.2 with
      GCC 2.96.

      In the NeL directory do :

         % ./configure --with-stlport=<Path_to_the_stlport_headers_files>
         % make

      The "configure" script must be call with the "--with-stlport" option.
      This option permit to override the default STL headers.

      You migth need to specify the FreeType 2 installation prefix by using
      the "--with-freetype" argument (ex: "/usr/local" will look for the
      header files in "/usr/local/include" and the library files in the
      "/usr/local/lid/ directory).

      To pass additional arguments to the C++ compiler, use the command line :

         % CXXFLAGS=-pipe ./configure --with-stlport=<STLPort_headers_path>

      To get the complete list of arguments of the "configure" script use the
      following command :

         % ./configure --help

      In the case that you need to rebuild the "configure" script and/or the
      "Makefile.in" files, execute the "bootstrap" script in the NeL
      directory :

         % ./bootstrap


Installation
============

   1. Windows installation
   -----------------------

      Not done yet.


   2. GNU/Linux installation
   --------------------------

      % make install