README is updated according to the new architecture

git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@502 331e1502-861f-0410-8da2-ba01fb791d7f
This commit is contained in:
jboisson 2007-07-03 09:53:59 +00:00
commit b2c054b34a

View file

@ -3,65 +3,71 @@
======================================================================= =======================================================================
Welcome to PARADISEO-MO (Moving Objects), one of the extension of Evolving Objects library. Welcome to PARADISEO-MO (Moving Objects), one part of the ParadisEO framework.
================================================================== =======================================================================
BUILDING PARADISEO-MO BUILDING PARADISEO-MO
================================================================== =======================================================================
The basic installation procedure goes the following: The basic installation procedure goes the following:
Go to your build-directory and run Go to your build-directory and run
./autogen --with-EOdir=$(EO_SRC) cmake . -DEOdir=$(EO_SRC)
make make
make doc //optional, for documentation if it is not already available.
make doc
where $(SRCDIR) is the top-level source directory of Paradiseo-eo (Evoling Object), i.e. where where $(EO_SRC) is the top-level source directory of ParadisEO-EO (Evoling Object), i.e. where
the sources where unpacked. the sources where unpacked.
To clean everything, in the simply run ======================================================================
make clean_all DIRECTORY STRUCTURE
======================================================================
===================================================================
DIRECTORY STRUCTURE
===================================================================
After unpacking the archive file, you should end up with the following After unpacking the archive file, you should end up with the following
structure: structure:
.../ The MAIN PARADISEO-MO directory, created when unpacking. .../ The MAIN PARADISEO-MO directory, created when unpacking.
| |
+-- src SOURCE directory Contains most PARADISEO-MO .h files. +-- src SOURCE directory contains most PARADISEO-MO .h files.
| |
| |
+-- doc DOCUMENTATION directory (generated by Doxygen). +-- doc DOCUMENTATION directory (generated by Doxygen).
| | | |
| +- html HTML files - start at index.html. | +- html HTML files - start at index.html.
| | | |
| +- latex latex files - use to generate Postcript doc. | +- latex latex files - use to generate Postcript doc.
| | | |
| +- man Unix man format documentation. | +- man Unix man format documentation.
| |
| |
+-- tutorial TUTORIAL with lessons +-- tutorial TUTORIAL with lessons
| | |
+-examples APPLICATIONS - one directory per separate application. | +- examples APPLICATIONS - one directory per separate application.
| | | | |
| +- tsp traveling salesman problem example. | | +- tsp traveling salesman problem (TSP) example.
| | | | |
| +-src sources files for the lesson examples using the tsp. | | +- src sources files for the lesson examples using the TSP.
| | | | |
| +-benchs TSP Instance files. | | +- benchs TSP Instance files.
| | |
+-Lesson1 How make a Hill Climbing on the TSP example. | +- Lesson1 How make a Hill Climbing on the TSP example.
| | | | |
| +-benchs TSP Instance files. | | +- build Repertory where the executable "hill_climbing" will be produced.
| | | |
+-Lesson2 How make a Tabu Search on the TSP example. | | +- src Hill climbing sources.
| | | |
| +-benchs TSP Instance files. | +- Lesson2 How make a Tabu Search on the TSP example.
| | | |
+-Lesson3 How make a Simulated Annealing on the TSP example. | | +- build Repertory where the executable "tabu_search" will be produced.
| | | |
+-benchs TSP Instance files. | | +- src Tabu search sources.
| |
| +- Lesson3 How make a Simulated Annealing on the TSP example.
| |
| +- build Repertory where the executable "simulated_annealing" will be produced.
| |
| +- src Simulated annealing sources.
|
+-- win All the stuff needs for the Windows version.
=================================================================== ===================================================================
NOTES NOTES
=================================================================== ===================================================================