README

Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.

This program and the accompanying materials are made available under the
terms of the Eclipse Public License v1.0 which accompanies this distribution,
and is available at http://www.eclipse.org/legal/epl-v10.html

DIRECTORY ORGANIZATION
======================

src/site:
	maven site plugin templates

mockito-configuration:
	default configuration of mockito framework

concepts:
	Common networking concepts, shared between the protocols

util:
	Common utility classes

framework:
	Common framework for integrating protocol parsers with Netty

bgp:
	BGP-related artifacts

pcep:
	PCEP-related artifacts

pcep/pcepy:
	Python PCEP library

pcep/pcepdump:
	Python-based PCEP listener and debug tool

rsvp:
	RSVP modeling concepts (needed by pcep)


HOW TO BUILD
============
In order to build it's required to have JDK 1.7+ and Maven 3+, to get
a build going it's needed to:

1) Go in the root directory and run
   "mvn clean install"

2) After successful completion, look for org.opendaylight.bgpcep artifacts
   in your local maven repository.