README.md

   1 Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   2
   3 This program and the accompanying materials are made available under the
   4 terms of the Eclipse Public License v1.0 which accompanies this distribution,
   5 and is available at http://www.eclipse.org/legal/epl-v10.html
   6
   7 ## DIRECTORY ORGANIZATION
   8
   9 * src/site:
  10     * maven site plugin templates
  11
  12 * mockito-configuration:
  13     * default configuration of mockito framework
  14
  15 * concepts:
  16     * Common networking concepts, shared between the protocols
  17
  18 * util:
  19     * Common utility classes
  20
  21 * bgp:
  22     * BGP-related artifacts
  23
  24 * pcep:
  25     * PCEP-related artifacts
  26
  27 * pcep/pcepy:
  28     * Python PCEP library
  29
  30 * pcep/pcepdump:
  31     * Python-based PCEP listener and debug tool
  32
  33 * rsvp:
  34     * RSVP modeling concepts (needed by pcep)
  35
  36 ## HOW TO BUILD
  37
  38 In order to build it's required to have JDK 1.7+ and Maven 3+, to get
  39 a build going it's needed to:
  40
  41 1. Go in the root directory and run
  42    `mvn clean install`
  43
  44 2. After successful completion, look for org.opendaylight.bgpcep artifacts in your local maven repository.