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