Updated teh INSTALL and README files that were really minimal!!!

This commit is contained in:
evomarc 2000-12-17 07:49:55 +00:00
commit ba78a70aa4
2 changed files with 118 additions and 10 deletions

View file

@ -1,3 +1,28 @@
EO INSTALL FILE
=======================================================================
check latest news at http://eodev.sourceforge.net/
=======================================================================
This file contains the standard installation instructions for packages
built using GNU package management facilities.
You should not need to read this file unless something goes wrong when
doing the basic install which goes:
- go to the EO directory - that was created when you unzipped the
archive file.
- run
./autogen.sh
- run
make
and that's it. You should probably go to the tutorial and start
learning about EO features and programming.
=======================================================================
Basic Installation
==================

103
eo/README
View file

@ -1,21 +1,104 @@
EO README FILE
=======================================================================
check latest news at http://eodev.sourceforge.net/
=======================================================================
Welcome to EO,
Welcome to EO, the Evolving Objects library.
The latest news about EO can be found on the sourceforge repository at
http://eodev.sourceforge.net/
In case of any problem, please e-mail us at
==================================================================
BUILDING EO
==================================================================
The basic installatio procedure goes the following:
- go to the EO directory - that was created when you unzipped the
archive file.
- run
./autogen.sh
- run
make
and that's it. You should probably go to the tutorial and start
learning about EO features and programming.
In case of problems, you can read the INSTALL file - but remember this
is a standard installation file from GNU and that it contains nothing
specific about EO.
===================================================================
DIRECTORY STRUCTURE
===================================================================
After unpacking the archive file, you should end up with the following
structure:
.../ the MAIN EO dir, created when unpacking
|
+-- src SOURCE dir. Contains most EO .h files
| |
| +- utils general utilities (e.g. RNG-related source files)
| |
| +- ga bistring-genotypes source files
| |
| +- es real-valued-genotypes source files
| |
| |
| +- gp Genetic Programming source files
| |
| |
| +- obsolete files from old versions - for upward compatibility
|
|
|
+-- tutorial TUTORIAL dir (indeed :-)
| |
| +- html all html files - start by browsing index.html
| |
| +- LessonX for X=1, 2, 3, ... : example of increasing complexity
|
|
|
+-- doc DOCUMENTATION dir (generated by Doxygen)
| |
| +- html HTML files - start at index.html (see also tutorial)
| |
| +- latex latex files - use to generate Poatscript doc.
| |
| +- man Unix man format documentation
|
|
+-- test TEST files - for debugging purposes only
|
|
+-- app APPLICATIONS - one dir per separate application
| |
| +- gprop GA/backpropagation for neural nets
| |
| +- mastermind the wellknown MasterMind game
|
|
+-- win WINDOWS dir: project files for MS/VC5+
===================================================================
NOTES
===================================================================
if you extracted a fresh snapshot from the cvs-repository, remember to do:
$> ./autogen.sh --enable-maintainer-mode
instead of
$> ./configure
$> ./autogen.sh
before making the libraries.
Documentation can be found in:
eo/doc/html
And \latex sources for a reference manual in:
eo/doc/latex
There are currently no examples except the programs in the test directory.
Only the files mentioned in Makefile.am will actually compile.