readme

C++ Reflection & Service Library

LICENSE
=======

C++ Reflection & Service Library

Copyright (C) 2003  Marcus Perlick
mailto: [e-mail]

This library is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as
published by the Free Software Foundation; either version 2.1 of the
License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
USA

DEPENDENCIES
============

- The FFCall library. (http://www.gnu.org/directory/ffcall.html)
  _Note_ that this library is distributed under the GPL, not the LGPL!

- RPC/XDR. For object serialisation we use XDR, which is part of the
  RPC software. Don't ask me, where to get it! It comes with my Linux
  distribution. But there should be versions for any popular OS.

- My "Multi Purpose Utility Library", which you can get from
  http://sourceforge.net/projects/reflection


HOW TO COMPILE
==============

GNU/Linux, g++ and GNU Make:
----------------------------
Currently this library is developed on a GNU/Linux
system. Particularly a SuSE 8.2 distribution. The only thing this
library currently depends on is a modern (since I use several C++
features) C++ compiler and a C++ standard library (g++ 3.2.2 works
fine). To compile it you will need an up-to-date version of GNU Make
that supports the 'eval' function (I'm using GNU Make 3.80).

When you've got all the tools, make sure all dependencies can be seen form the
reflection library's repository. For FFCall an XDR I assume, you have
installed them and they will be found. For the mpUtil library there is not yet
an installation procedure, so I assume, you will use it from where you
compiled it. To let the reflection library find it, set the environment
variable 'WOKRSPACE' to the directory, where the mpUtil resides in. This
means, if you find the mpUtil directory in <some-dir>, type in bash-like
shells:

    export WORKSPACE=<some-dir>

Now, the refletcion makefiles should find the mpUtil stuff. The compilation
process is still straight forward! Type

	make

in the directory, this files resides in. That will build a debug
version of the library. Note, that e.g. the MVector classes use
recursive templates, which makes the debug version a really big
library and the MVectors fairly slow. If you don't plan to debug this
lib, you should use

	make BUILD_CFG=release

For more details have a look at the 'make.config' file. The resulting
libraries will reside in the project's root directory in a folder
called 'bcfg-<config>' where <config> is either 'default' for the
debug or 'release' for the release version. This gives you the chance
to have both versions compiled.

Others:
------- 
You are on your own! The general idea is to compile anything in the
./src folder that ends with '.cc' into one library. That's it.

HOW TO INSTALL:
===============

No installaton, yet!