Add README.md to parent

README.md with basic information's about project configuration, building, etc.

Issue-ID: INT-1517
Signed-off-by: Zebek Bogumil <bogumil.zebek@nokia.com>
Change-Id: Id3ea8bdffc93f1cb50c21312763182c28eb86700

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..6300184
--- /dev/null
+++ b/README.md
@@ -0,0 +1,42 @@
+# PNF Simulator
+
+## General description
+
+More information about the project and all its functionalities you can find under the wiki page:
+https://wiki.onap.org/display/DW/PNF+Simulator
+
+Project consists of three submodules:
+1. netconfsimulator
+2. pnfsimulator
+3. simulator-cli
+
+Detailed information about submodules can be found in ```README.md``` in their directories.
+
+## Project building
+```
+mvn clean package
+```
+## Building Docker images
+```
+mvn clean package -P docker -DskipTests=true
+```
+
+## Sonar
+
+https://sonarcloud.io/dashboard?id=onap_integration-pnf-simulator
+
+## Jenkins Jobs Configuration
+
+https://gerrit.onap.org/r/gitweb?p=ci-management.git;a=blob;f=jjb/integration/simulators/integration-pnf-simulator.yaml;h=df000a15db1c4774e05b98f26a960d4ce88dbde0;hb=HEAD
+
+## Jenkins Jobs
+
+https://jenkins.onap.org/view/integration/search/?q=integration-pnf-simulator&Jenkins-Crumb=01c2163ed26687ffc4877fedc6bdc9a7eb3d108abd3144d016a6cd7a84e24bb2
+
+## Nexus repository
+Images are available at Nexus:
+1. netconfsimulator
+    https://nexus3.onap.org/#browse/search=keyword%3Dnetconfsimulator
+    https://nexus3.onap.org/#browse/search=keyword%3Dnetopeer
+2. pnfsimulator
+    https://nexus3.onap.org/#browse/search=keyword%3Dpnfsimulator