X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=blobdiff_plain;f=INSTALL.rst;fp=INSTALL.rst;h=310bffe413d1135718939e2d6fce787f523f2e2d;hb=421bd97023e853a9e87d16e100b23bf3c60a9188;hp=0000000000000000000000000000000000000000;hpb=51cd08d9a3f2826088d122e2a5683315c77a2786;p=samplevnf.git

diff --git a/INSTALL.rst b/INSTALL.rst
new file mode 100644
index 00000000..310bffe4
--- /dev/null
+++ b/INSTALL.rst
@@ -0,0 +1,30 @@
+.. this work is licensed under a creative commons attribution 4.0 international
+.. license.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) opnfv, national center of scientific research "demokritos" and others.
+
+============================
+SAMPLEVNF Installation Guide
+============================
+
+Introduction
+============
+This project provides a placeholder for various sample VNF (Virtual Network Function)
+development which includes example reference architecture and optimization methods
+related to VNF/Network service for high performance VNFs. 
+
+The sample VNFs are Open Source approximations* of Telco grade VNF’s using
+optimized VNF + NFVi Infrastructure libraries, with Performance Characterization
+of Sample† Traffic Flows.
+• * Not a commercial product. Encourage the community to contribute and close the feature gaps.
+• † No Vendor/Proprietary Workloads 
+
+VNF supported
+=============
+ 1. CG-NAT (Carrier Grade Network Address Translation) VNF
+ 2. Firewall (vFW) VNF
+ 4. Access Control List (vACL) VNF
+
+Please refer docs folder for individual VNF Installation guide.
+
+Note:- Each VNF should include a installation document explain the process to install and run VNF.