Remove stale prerequisite sections
[bgpcep.git] / README
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
10 src/site:
11         maven site plugin templates
12
13 mockito-configuration:
14         default configuration of mockito framework
15
16 concepts:
17         Common networking concepts, shared between the protocols
18
19 util:
20         Common utility classes
21
22 bgp:
23         BGP-related artifacts
24
25 pcep:
26         PCEP-related artifacts
27
28 pcep/pcepy:
29         Python PCEP library
30
31 pcep/pcepdump:
32         Python-based PCEP listener and debug tool
33
34 rsvp:
35         RSVP modeling concepts (needed by pcep)
36
37
38 HOW TO BUILD
39 ============
40 In order to build it's required to have JDK 1.7+ and Maven 3+, to get
41 a build going it's needed to:
42
43 1) Go in the root directory and run
44    "mvn clean install"
45
46 2) After successful completion, look for org.opendaylight.bgpcep artifacts
47    in your local maven repository.