1) About
============
Phosphorus-g2mpls implements various IPv4 protocols and modules for
the G2MPLS Control Plane.

The phosphorus-g2mpls source code has the following structure:

g2mpls_common:  contains the source code related to the G2MPLS
                common library, containing many common
                utilities for G2MPLS purposes.

g2mpls_modules: contains the source code related to the G2MPLS protocols,
                based on the substrate of Quagga v0.99.7 routing suite.

g2mpls_idl:     contains all the description files (*.idl) related to the CORBA
                interfaces between the G2MPLS modules, including the G2MPLS
                common types (types.idl and g2mplsTypes.idl) used on the
                external interfaces.


2) License 
=============
The G2MPLS common library is released under the GNU LGPLv2.1 licence, while the
portion of source code related to the G2MPLS modules is free software released
under GNU GPLv2 licence.
See the files COPYING and COPYING.LESSER in docs subfolder for more details on the
license.


3) Installation/usage how to
===============================
The  source code installation is based upon the commonly
called autotools suite. The autotools suite is mainly composed by three
different GNU tools: autoconf (http://www.gnu.org/software/autoconf),
automake (http://www.gnu.org/software/automake) and libtool
(http://www.gnu.org/software/libtool).

To compile and install the phosphorus-g2mpls package in a
single shot, not caring of all the possible 'configure' options, should run 
a script available in the root source code directory: 'build.sh'. This script 
takes care to run the 'configure' scripts, build and install the G2MPLS common 
library and all the G2MPLS modules using the autotools suite available in the 
system.

./build.sh
Usage: build.sh [COMMAND]

Commands:
        bc | build-common
        bm | build-modules
        ba | build-all
        cc | clean-common
        cm | clean-modules
        ca | clean-all

To build the source code and install all the stuffs in the 
phosphorus-g2mpls/build directory, the command to be run is:

./build.sh build-all

On the other hand, to remove all the program binaries, object files and files
created by 'configure' the command to be run is:

./build.sh clean-all

See the source-code-installation-guide.txt in docs subfolder for
more details on building and installation instructions.

4) Documents
===============
In the docs subfolder of Phosphorus G2MPLS source code package are available the
following documents:

COPYING: GNU GPLv2 licence for G2MPLS modules portion of the source code;

COPYING.LESSER: GNU LGPLv2.1 licence for the G2MPLS common library;

Phosphorus-g2mpls-install-guide.doc: detailed installation guide of the
				     Phosphorus G2MPLS source code package;

Phosphorus-g2mpls-sys-req.doc: system requirements, in terms of Linux/Gentoo
			       packages, for a proper usage of the Phosphorus
			       G2MPLS suite.

For further details on Phosphorus G2MPLS source code structure, installation and
configuration please check the following publicly available Phosphorus WP2
deliverables:

D2.10 - Final Grid-GMPLS Control plane prototype
	(http://www.ist-phosphorus.eu/wiki/index.php/Image:Phosphorus-deliverable-D2.10.pdf)
D2.11 - Consolidated Grid-GMPLS Control Plane prototype
	(http://www.ist-phosphorus.eu/wiki/index.php/Image:Phosphorus-deliverable-D2.11.pdf)