diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..ca172da2040d51ad0de04690db6e07ffbd7dcfa9 --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +# Member VM Automation + +Automates the creation of member VMs based on a template VM in Proxmox. + +## How to use + +1. Create a branch in the repository and make your desired changes to + `membervm_nogui.yml`. If you are requesting a new VM, you can duplicate + an existing block and modify to suit. +2. Create a merge request and request review from a Wheel member. +3. The CI should run to check your addition was made correctly. +4. Once approved, your branch will be merged in and your VM will be created + automatically within a few minutes.