paradiseo/trunk/paradiseo-mo
jboisson 2fd9b65959 readme has been updated for the instances of the bench directory
git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@819 331e1502-861f-0410-8da2-ba01fb791d7f
2007-11-26 13:22:28 +00:00
..
doc New doc is made 2007-10-23 13:38:14 +00:00
src Tsp fitness has been changed and moSA.h has been updated 2007-11-26 08:46:41 +00:00
test New style for MO 2007-11-16 11:25:54 +00:00
tutorial readme has been updated for the instances of the bench directory 2007-11-26 13:22:28 +00:00
AUTHORS AUTHORS, index.h and moFitComparator have been updated 2007-09-25 14:31:28 +00:00
CMakeLists.txt default build type is now "" for mingw compatibility 2007-11-23 16:03:58 +00:00
mo-conf.cmake Added wonderful test stuff 2007-09-18 15:45:15 +00:00
README licence --> license in english.. 2007-10-08 13:27:08 +00:00

                      PARADISEO-MO README FILE
=======================================================================
         
=======================================================================

Welcome to PARADISEO-MO (Moving Objects), one part of the ParadisEO framework.

=======================================================================
                      BUILDING PARADISEO-MO
=======================================================================
The basic installation procedure goes the following:

To compile paradiseo-mo in the default directory,
go to paradiseo-mo/build/ and run:
    > cmake ../ -Dconfig=<path to the install.cmake file>
    > make
    // for an easy-use of the provided lessons
    > make install
    // optional (if the documentation is not already available)
    > make doc

To compile paradiseo-mo anywhere else, simply run:
    > cmake $(MO) -Dconfig=<path to the install.cmake file>
    > make
    // for an easy-use of the provided lessons
    > make install
    // optional (if the documentation is not already available)
    > make doc

where $(MO) is the top-level directory of PARADISEO-MO.

To clean everything, simply run
    > make clean

======================================================================
                      DIRECTORY STRUCTURE
======================================================================
After unpacking the archive file, you should end up with the following
structure:

.../                       The MAIN PARADISEO-MO directory, created when unpacking.
   |
   +-- build               Repertory where the executables will be produced.	
   |
   |
   +-- src                 SOURCE directory contains most PARADISEO-MO .h files.
   |   
   |
   +-- doc                 DOCUMENTATION directory (generated by Doxygen).
   |   |
   |   +- html             HTML files - start at index.html. 
   |   |
   |   +- latex            latex files - use to generate Postcript doc.
   |   |
   |   +- man              Unix man format documentation.
   |
   |
   +-- tutorial            TUTORIAL with lessons 
       |
       +- examples         APPLICATIONS - one directory per separate application.
       |  |
       |  +- tsp           traveling salesman problem (TSP) example sources.
       |     |
       |     +- benchs     TSP instance files.
       |   
       +- Lesson1          How make a Hill Climbing on the TSP example (source file and lesson_1.pdf).
       |
       +- Lesson2          How make a Tabu Search on the TSP example (source file and lesson_2.pdf).
       |  
       +- Lesson3          How make a Simulated Annealing on the TSP example (source file and lesson_3.pdf).
   
===================================================================
              NOTES
===================================================================

Mailing list : paradiseo-help@lists.gforge.inria.fr