Add perltidy to pre-commit linters
[transportpce.git] / lighty / README.md
1 # Lighty-TransportPCE Controller
2
3 This project starts [TransportPCE](https://git.opendaylight.org/gerrit/#/admin/projects/transportpce) without karaf framework.
4
5 ## Build & Run
6 * Make sure you have JDK11 or later installed.
7 * Make sure you have [maven 3.5.2](https://maven.apache.org/download.cgi) or later installed.
8 * Make sure you have proper [settings.xml](https://github.com/opendaylight/odlparent/blob/master/settings.xml)  in your ``~/.m2`` directory.
9
10 #### Before compiling Lighty-TransportPCE
11 Make sure upstream projects are compiled locally and stored in local ``~/.m2/repository``:
12 1. compile __transportpce/master__
13 ```
14 git clone https://git.opendaylight.org/gerrit/transportpce && (cd transportpce && curl -kLo `git rev-parse --git-dir`/hooks/commit-msg https://git.opendaylight.org/gerrit/tools/hooks/commit-msg; chmod +x `git rev-parse --git-dir`/hooks/commit-msg)
15 cd transportpce
16 ```
17 mvn clean install -s tests/odl_settings.xml -DskipTests -Dmaven.javadoc.skip=true -Dodlparent.spotbugs.skip -Dodlparent.checkstyle.skip
18 ```
19 2. compile __lighty-core/12.1.x__
20 ```
21 git clone https://github.com/PantheonTechnologies/lighty-core.git
22 cd lighty-core
23 git checkout 12.1.x
24 mvn clean install -DskipTests -Dmaven.javadoc.skip=true
25 ```
26 #### Compile Lighty-TransportPCE
27 * Project is build using maven command:
28 ```
29 cd ../lighty
30 mvn clean install -Dmaven.javadoc.skip=true
31 ```
32 * After project build is done, use binary package to run the TransportPCE controller.
33 ```
34 cd  target
35 unzip lighty-transportpce-12.1.0-SNAPSHOT-bin.zip
36 cd lighty-transportpce-12.1.0-SNAPSHOT
37 ./start-controller.sh
38 ```
39 * The whole build process described here and in the previous section can be performed automatically by launching the script build.sh from lighty folder.
40
41 ## TransportPCE lighty.io - karaf comparison
42
43 see the previous version of this file in README.neon.md