doc/html/_r_e_a_d_m_e_source.html

00001                       EO README FILE
00002
00003 =======================================================================
00004          check latest news at http://eodev.sourceforge.net/
00005 =======================================================================
00006
00007 Welcome to EO, the Evolving Objects library.
00008
00009 The latest news about EO can be found on the sourceforge repository at
00010     http://eodev.sourceforge.net/
00011
00012 In case of any problem, please e-mail us at
00013     eodev-main@lists.sourceforge.net
00014
00015 To get started, take a look at the tutorial, starting with
00016     ./tutorial/html/eoTutorial.html
00017
00018 The easiest way to start programming a new genome with all EO
00019 evolution engines handy is to create a new standalone EO project from
00020 the tutorial/Templates/ directory. Read Lesson 5 of the tutorial for
00021 an introduction ;)
00022
00023
00024 ==================================================================
00025                       BUILDING EO
00026 ==================================================================
00027 The basic installation procedure goes the following:
00028
00029 Go to the "eo/" and run one of the "build_*" script.
00030
00031 Using the "build_gcc_linux_release" script is generally what you want. The
00032 binaries are then located in the "release/" directory.
00033
00034 Now you should probably go to the tutorial and start learning about EO
00035 features and programming.
00036
00037 In case of problems or if you want advanced options, you can read the INSTALL file.
00038
00039 ===================================================================
00040                        DIRECTORY STRUCTURE
00041 ===================================================================
00042 After unpacking the archive file, you should end up with the following
00043 structure:
00044
00045 .../                            the MAIN EO dir, created when unpacking
00046    |
00047    +-- src                    SOURCE dir. Contains most EO .h files
00048    |   |
00049    |   +- utils          general utilities (e.g. RNG-related source files)
00050    |   |
00051    |   +- ga             bistring-genotypes source files
00052    |   |
00053    |   +- es             real-valued-genotypes source files
00054    |   |
00055    |   +- gp             Genetic Programming source files
00056    |   |
00057    |   +- obsolete       files from old versions - for upward compatibility
00058    |
00059    |
00060    |
00061    +-- tutorial               TUTORIAL dir (indeed :-)
00062    |   |
00063    |   +- html           all html files - start by browsing index.html
00064    |   |
00065    |   +- LessonX        for X=1, 2, 3, ... : example of increasing complexity
00066    |
00067    |
00068    |
00069    +-- doc                    DOCUMENTATION dir (generated by Doxygen)
00070    |   |
00071    |   +- html             HTML files - start at index.html (see also tutorial)
00072    |   |
00073    |   +- latex            latex files - use to generate Poatscript doc.
00074    |   |
00075    |   +- man              Unix man format documentation
00076    |
00077    |
00078    +-- test                   TEST files - for debugging purposes only
00079    |
00080    |
00081    +-- app                    APPLICATIONS - one dir per separate application
00082    |   |
00083    |   +- gprop            GA/backpropagation for neural nets
00084    |   |
00085    |   +- mastermind       the wellknown MasterMind game
00086    |
00087    |
00088    +-- win                    WINDOWS dir: project files for MS/VC5+
00089