Merge "Call per page clean up if that is defined."
[controller.git] / README.OPENDAYLIGHT
1 DIRECTORY ORGANIZATION
2 ======================
3 - third-party: contains all the third-party artifacts than needed
4 repackaging or needed code modifications.
5 - third-party/commons: contains all the parent POM files for the
6 projects under the third-party directory. Only one is expected, which
7 is the one located under third-party/commons/third-party, but there is
8 a directory just in case we need to host more with different
9 variations.
10 - opendaylight: contains all the artifacts that constitute the
11 controller project.
12 - opendaylight/distribution: contains all the distributions that can
13 be generated by packaging the several artifact. In practice for now
14 there are two:
15       - "opendaylight", which is the full distribution of the controller
16       - "sdk", which contains only the artifact needed to build an app
17       against the controller (beaware this is still incomplete)
18 The idea of the distribution directory is that more distribution can
19 be added at will, maybe just composing subsets of the whole controller
20 artifact set.
21
22 HOW TO BUILD
23 ============
24 In order to build it's required to have JDK 1.7+ and Maven 3+, to get
25 a build going it's needed to:
26 1) Choose the distribution, from within opendaylight/distribution
27 2) Go in the directory and run
28    "mvn clean install"
29 3) On succesfull completion go in the target directory to pick the zip
30 file of the distribution or controller can be executed right from
31 there going into the distribution directory.
32
33 Thanks!!
34

©2013 OpenDaylight, A Linux Foundation Collaborative Project. All Rights Reserved.
OpenDaylight is a registered trademark of The OpenDaylight Project, Inc.
Linux Foundation and OpenDaylight are registered trademarks of the Linux Foundation.
Linux is a registered trademark of Linus Torvalds.