Initial OpenECOMP Demo commit

[demo.git] / README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..98b68a2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+OpenECOMP Platform Instantiation and Demo Applications
+---
+
+This project contains the source code and scripts to instantiate OpenECOMP and the two demo applications, vFirewall and vLoadBalancer/vDNS. 
+
+This repository includes:
+
+- README.md: this file
+
+- LICENSE.TXT: the license file
+
+- The "boot" directory: the scripts to instantiate OpenECOMP. 
+
+- The "heat" directory: the heat templates to instantiate OpenECOMP and the demo applications. 
+
+- The "vnfs" directory: the scripts and source codes for running the two demo applications. 
+
+Usage
+---
+
+To instantiate OpenECOMP, please download and run the heat template and environment files in "heat/OpenECOMP". Please follow instructions in "heat/README.md" for further details. 
+
+