Update README file (#93)

* update README file

Signed-off-by: dianew <[email protected]>

Author: Tomorrow9

README.md

@@ -1,11 +1,17 @@
-# Project for Guest OS Validation test on vSphere using Ansible
+# Guest OS Validation on vSphere using Ansible
 
 ## Getting Started
 
 ### Prerequisites
 1. Install Ansible on your control machine, please refer to [Installing Ansible](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html)
 2. Install required Python libraries in requirements.txt
+```
+$ pip install -r requirements.txt
+```
 3. Install required Ansible collections in requirements.yml
+```
+$ ansible-galaxy install -r requirements.yml
+```
 4. Log in to local control machine as root or a user in sudoers
 
 ### Steps to Launch Testing
@@ -19,27 +25,30 @@
   # For Linux testing:
   # you can use below command to use the default variables file "vars/test.yml",
   # default test case list file "linux/gosv_testcase_list.yml"
-  ansible-playbook main.yml
+  $ ansible-playbook main.yml
 
   # For Linux or Windows testing:
   # you can use below command to set the path of a customized variables file and
   # test case list file
-  ansible-playbook main.yml -e "testing_vars_file=/path_to/test.yml testing_testcase_file=/path_to/gosv_testcase_list.yml"
+  $ ansible-playbook main.yml -e "testing_vars_file=/path_to/test.yml testing_testcase_file=/path_to/gosv_testcase_list.yml"
 ```
+5. New folder for log files and files collected in test cases are created for current test run,
+e.g., "logs/test-vm/2021-07-06-09-27-51/",
+find test case results in "results.log", failed tasks in "failed_tasks.log", testing debug log in "full_debug.log". 
 
 ### Catalog
 * main.yml: Main playbook for Guest OS validation test
 * ansible.cfg: User customized Ansible configuration file
 * autoinstall: Folder for guest OS unattend install configuration files
 * common: Folder for common tasks called in test cases
-* docs: Folder for guide files
+* docs: Folder for guide file and known issues
 * env_setup: Folder for playbooks or tasks which to prepare or cleanup testing environment
 * linux: Folder for playbooks to test Linux guest OS
-* Windows: Folder for playbooks to test Windows guest OS
+* windows: Folder for playbooks to test Windows guest OS
 * plugin: Folder for plugin scripts
 * tools: Folder for 3rd-party tools used in test cases
 * vars: Folder for variable files used in testing
-* logs: Folder generated by default for files collected and logs generated in test run
+* changelogs: Folder for changelog of each release 
 
 ### Supported Testing Scenarios
 This project supports below scenarios for end-to-end guest OS validation testing 
@@ -71,12 +80,17 @@ This project supports below scenarios for end-to-end guest OS validation testing
 | Windows Server SAC releases                     | :heavy_check_mark:               |                          | :heavy_check_mark:                 |
 
 ### Docker images
-* Release v1.0 or the latest:
-```
-# docker pull projects.registry.vmware.com/gos_cert/ansible-vsphere-gos-validation:v1.0
-or
-# docker pull projects.registry.vmware.com/gos_cert/ansible-vsphere-gos-validation:latest
+* Latest (Release v1.1):
+  * projects.registry.vmware.com/gos_cert/ansible-vsphere-gos-validation:latest
+* Release v1.1:
+  * projects.registry.vmware.com/gos_cert/ansible-vsphere-gos-validation:v1.1
+* Release v1.0:
+  * projects.registry.vmware.com/gos_cert/ansible-vsphere-gos-validation:v1.0
 
-# docker run -it --privileged projects.registry.vmware.com/gos_cert/ansible-vsphere-gos-validation:v1.0
+Launch testing using Docker image
+1. Execute below commands in your machine
+```
+$ docker pull projects.registry.vmware.com/gos_cert/ansible-vsphere-gos-validation:latest
+$ docker run -it --privileged projects.registry.vmware.com/gos_cert/ansible-vsphere-gos-validation:latest
 ```
-Then launch testing in container using the steps in this section [Steps to Launch Testing](#steps-to-launch-testing)
+2. Launch testing in the started container following the steps in this section [Steps to Launch Testing](#steps-to-launch-testing)