Add a README file
[bgpcep.git] / README
1 DIRECTORY ORGANIZATION
2 ======================
3
4 build:
5         configuration of build-time components, such as checkstyle plugin.
6
7 src/site:
8         maven site plugin templates
9
10 mockito-configuration:
11         default configuration of mockito framework
12
13 concepts:
14         Common networking concepts, shared between the protocols
15
16 util:
17         Common utility classes
18
19 framework:
20         Legacy NIO-based protocol framework, to be replaced by Netty
21
22 bgp:
23         BGP-related artifacts
24
25 pcep:
26         PCEP-related artifacts
27
28
29 HOW TO BUILD
30 ============
31 In order to build it's required to have JDK 1.7+ and Maven 3+, to get
32 a build going it's needed to:
33
34 1) Go in the root directory and run
35    "mvn clean install"
36
37 2) After successful completion, look for org.opendaylight.bgpcep artifacts
38    in your local maven repository.