DOCS: Added docs folder and Readme

This patch added docs folder and Readme.
It also moves pylintrc to home-folder.

Signed-off-by: Sridhar K. N. Rao <sridhar.rao@spirent.com>
Change-Id: I1297ee26cdaba34455b276b63c69606f1c650c6a

4 files changed, 42 insertions, 1 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c86c618
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+<!---
+This work is licensed under a Creative Commons Attribution 4.0 International License.
+http://creativecommons.org/licenses/by/4.0
+-->
+
+# CIRV - Common Infrastructure Realization & Validation
+
+Documentation for this project is contained under the **./docs** directory.
+Additional information about CIRV project are available at [project wiki].
+
+---
+
+[project wiki]: https://wiki.opnfv.org/display/CIRV
diff --git a/docs/valid.rst b/docs/valid.rst
new file mode 100644
index 0000000..6aeb8a2
--- /dev/null
+++ b/docs/valid.rst
@@ -0,0 +1,28 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Intel Corporation, AT&T and others.
+
+CIRV Software Validation Tool
+=============================
+This tool is designed to perform Software Configuration Validation, which covers:
+
+1. Pre-Deployment (of VIM or Container Management Software) Validation of Software Configuration
+2. Post-Deployment (of VIM or Container Management Software) Validation of Software Configuration
+3. Network-Link Checking - Validating VLAN and IP configurations
+
+
+Installation
+************
+This tool does not have any installation. However, there are requirements in terms of Python packages, which can be installed using pip3. Refer to requirements.txt file for the package list.
+
+Usage
+*****
+Example Commands:
+
+1. To run all the validations: ./valid
+2. Help: ./valid --help
+3. Version Check: ./valid --version
+4. List Sofware Pre-Deployment validators: ./valid --list-swpredepv
+5. List Sofware Post-Deployment validators: ./valid --list-swpostdepv
+6. List all validations: ./valid --list-validations
+7. Run only single validation [WORK IN PROGRESS]
diff --git a/tools/pylintrc b/pylintrc
index 4900d67..4900d67 100644
--- a/tools/pylintrc
+++ b/pylintrc
diff --git a/tools/sdv/conf/__init__.py b/tools/sdv/conf/__init__.py
index c7dadca..4e68c70 100644
--- a/tools/sdv/conf/__init__.py
+++ b/tools/sdv/conf/__init__.py
@@ -48,7 +48,7 @@ class Settings(object):
 
     def _eval_param(self, param):
         # pylint: disable=invalid-name
-        """ Helper function for expansion of references to vsperf parameters
+        """ Helper function for expansion of references to 'valid' parameters
         """
         if isinstance(param, str):
             # evaluate every #PARAM reference inside parameter itself