Merge pull request #10 from Zuehlke/feature/update-readme

Update README

Author: tknerr

README.md

@@ -1,11 +1,9 @@
 
 # Linux Developer VM Example / Template
 
-[![Circle CI](https://circleci.com/gh/Zuehlke/linux-developer-vm-with-ansible/tree/master.svg?style=shield)](https://circleci.com/gh/Zuehlke/linux-developer-vm-with-ansible/tree/master)
-
 A minimal example / template project for an Ansible-managed Linux Developer VM.
 
-![Linux Developer VM Screenshot](https://user-images.githubusercontent.com/365744/79437115-0b707300-7fd2-11ea-964f-0b5a0ff36d05.png)
+![Linux Developer VM Screenshot](https://user-images.githubusercontent.com/365744/122089607-3721ff80-ce07-11eb-801e-661715e95aaa.png)
 
 It's meant to be copy/pasted and filled with life. The `roles/` directory contains the roles
 for setting up the VM, the `spec/` directory contains the tests that come along with it.
@@ -15,12 +13,15 @@ All your specific customizations go in there!
 
 For the Chef-based equivalent of it, see https://github.com/Zuehlke/linux-developer-vm
 
-
 ## What's included?
 
 ### Main tools
 
-These are the main tools included in this developer VM (see CHANGELOG for the specific versions):
+These are the main tools included in this developer VM:
+
+ * ...(add your tools here)
+
+Apart from the above, the following tools are used to set up and maintain this developer VM:
 
  * [Ansible](https://docs.ansible.com/ansible/latest/index.html) - for managing / installing this developer VM
  * [Ansible-lint](https://github.com/ansible/ansible-lint) - to ensure best practices when adding more Ansible roles
@@ -61,21 +62,22 @@ You can run these commands from anywhere inside the developer VM:
 
 ### Further Usage Instructions
 
-For further instructions, please refer to the README.md that is placed on the Desktop of the Developer VM:
+For general instructions, please refer to the README.md that is placed on the Desktop of the Developer VM:
 
-* https://github.com/Zuehlke/linux-developer-vm-with-ansible/blob/master/roles/readme/files/README.md
+* [roles/readme/files/README.md](./roles/readme/files/README.md)
 
 
-## Development
+## Building and Packaging the VM
 
 ### Prerequisites
 
-You only need [VirtualBox](http://virtualbox.org/wiki/Downloads) and [Vagrant](http://www.vagrantup.com/)
-installed.
+You only need [VirtualBox](http://virtualbox.org/wiki/Downloads) and [Vagrant](http://www.vagrantup.com/) installed.
+
+If you want to build a VMware .ova image, you will need a [VMware Workstation (Pro) or VMware Fusion](https://www.vmware.com/products/desktop-hypervisor.html) + [Vagrant VMware Plugin](https://www.vagrantup.com/vmware).
 
 All other requirements, including Ansible will be installed *inside the Vagrant VM* during provisioning, i.e. you don't need them installed on your host machine.
 
-### Basic Development Workflow
+### Building
 
 Bring up the developer VM:
 ```
@@ -97,28 +99,27 @@ should see all tests passing:
 ```
 ...
     default: ============================= test session starts ==============================
-    default: platform linux -- Python 3.8.2, pytest-5.4.1, py-1.8.1, pluggy-0.13.1 -- /usr/bin/python3
-    default: cachedir: .pytest_cache
+    default: platform linux -- Python 3.8.5, pytest-6.2.4, py-1.10.0, pluggy-0.13.1
     default: rootdir: /home/user/vm-setup
-    default: plugins: testinfra-5.0.0, spec-2.0.0
-    default: collecting ...
+    default: plugins: testinfra-6.3.0, spec-3.2.0
     default: collected 8 items
     default:
     default: spec/test_ansible.py:
-    default: ✓ Ansible is installed at version 2 9 6 [local]
-    default: ✓ Ansible commands are found [local]
-    default: ✓ Ansible version command reports version 2 9 6 [local]
+    default:   ✓ Ansible is installed at version 2 9 22 [local]
+    default:   ✓ Ansible commands are found [local]
+    default:   ✓ Ansible version command reports version 2 9 22 [local]
     default:
     default: spec/test_ansible_lint.py:
-    default: ✓ Ansible lint is installed at version 4 2 0 [local]
-    default: ✓ Ansible lint command is found [local]
-    default: ✓ Ansible lint version command reports version 4 2 0 [local]
+    default:   ✓ Ansible lint is installed at version 5 0 12 [local]
+    default:   ✓ Ansible lint command is found [local]
+    default:   ✓ Ansible lint version command reports version 5 0 12 [local]
     default:
     default: spec/test_testinfra.py:
-    default: ✓ Testinfra is installed at version 5 0 0 [local]
-    default: ✓ Pytest spec is installed at version 2 0 0 [local]
+    default:   ✓ Testinfra is installed at version 6 3 0 [local]
+    default:   ✓ Pytest spec is installed at version 3 2 0 [local]                    [100%]
+    default:
     default:
-    default: ============================== 8 passed in 4.05s ===============================
+    default: ============================== 8 passed in 28.56s ==============================
 ```
 
 If these are passing as expected, you can continue developing on the Ansible roles within this repo.
@@ -145,20 +146,34 @@ First, unmount the /vagrant shared folder:
 $ vagrant ssh -c "sudo umount /vagrant -f"
 ```
 
-Finally, shutdown the VM, remove the sharedfolder, and export the VM as an .ova file:
+Then remove the vagrant user account:
+```
+$ vagrant ssh -c "sudo pkill -KILL -u vagrant"
+$ vagrant ssh -c "sudo userdel -f -r vagrant"
+```
+
+Finally, shutdown the VM, remove the sharedfolder, and export the VM as an .ova file
+
+For VirtualBox:
 ```
 $ vagrant halt
 $ VBoxManage sharedfolder remove "Linux Developer VM" --name "vagrant"
 $ VBoxManage modifyvm "Linux Developer VM" --name "Linux Developer VM v0.1.0"
 $ VBoxManage export "Linux Developer VM v0.1.0" --output "linux-developer-vm-v0.1.0.ova" --options manifest,nomacs
 ```
 
+For VMware:
+```
+$ vagrant halt
+$ VMX_FILE=`cat .vagrant/machines/default/vmware_desktop/id`
+$ ovftool --name="Linux Developer VM v0.1.0" "$VMX_FILE" linux-developer-vm-v0.1.0.ova
+```
+
 Don't forget to throw away the VM when you are done:
 ```
 $ vagrant destroy -f
 ```
 
-
 ## Contributing
 
  1. Fork the repository on Github