################################################################
#                                                              #
#                                                              #
#      OO  DDDD    EEEE   M M                                  #
#    O   O D   D   E     M M M   X X                           #
#   O    O D    D EEEE  M  M  M   X                            #
#   O  @ O D @  D E     M     M  X X                           #
#    OOOO   DDDD  EEEEE M     M X   X                          #
#                                                              #
#    ODEMx  version 3.0                                        # 
#   --------------------                                       #
#                                                              #
#    Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009    #
#                       Humboldt-Universität zu Berlin and     #
#                       Ralf Gerstenberger and                 #
#                       Ronald Kluth                           #
#                                                              #
################################################################

  Welcome
 ---------
 Welcome to ODEMx. ODEMx is a C++ library for discrete event simulation.


  About ODEMx
 -------------
ODEMx is a library for discrete event simulation, which is a 
branch of computer simulation. It supports process-based and event-
based simulation models. As such it uses processes and/or events to
model real-world or fictional systems. A process in this context
is a continuous or discrete sequence of actions which are somehow
closely related to each	other, for instance they are all 'done' by
one agent. The sequence can be divided into branches, and broken
off by idle periods or synchronisation. Events in this context simply
describe one action in a system that can take place at any time during
a simulation. 


  Copyright and License
 -----------------------
ODEMx is protected by the GNU LESSER GENERAL PUBLIC LICENSE as
described in the file Copying.txt, which should be present in 
the ODEMx package; if not, write to the Free Software Foundation,
Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.

The examples in examples/omsi are released under the GNU GENERAL 
PUBLIC LICENSE, Version 2.

  Installation
 --------------
For a precise description on how to build ODEMx for your plattform,
please read the file BUILDING.

There is no installation procedure for ODEMx, at least not in
this version. To use ODEMx in your projects choose the respective
folder that fits your needs best (Gcc on Unix and Linux systems, Msvc 
or Msvc7.1 on windows), build the library and finally set-up your 
project to use the library.

Note:
If you are using GCC we recommend to use a version higher than 3.x.x.

Always take care to activate RTTI in your projects, because ODEMx
depends on this feature. (MSVC and MSCVC7.1 disable RTTI by default)
 

  First Steps
 -------------
At first you will have to build ODEMx - see Installation for details.
Afterwards try the examples included. That should give you a good start.
Apart from that you can use them to check whether ODEMx is working properly
on your computer.

ODEMx includes an online documentation as well. You will need Doxygen
(http://www.doxygen.org) to generate the documentation from the source files.
To do so, go to your build directory and run "make doxygen". This will
build the doxygen documentation and put it into $BUILDIR/doc/html .


  Contributions
 ---------------
ODEMx is based on ODEM (http://odem.sf.net). That's why all contributors of 
ODEM could be listed here, too. Instead only those who put their
hands on this code directly will be mentioned. Anyway, we encourage
you to take a look at ODEM and its contributors list as well.
 
Ralf Gerstenberger (gerstenb@users.sourceforge.net)
Ronald Kluth
Toralf Niebuhr
Magnus Müller

EOF
