Update README

This commit is contained in:
Marcel von Maltitz 2018-02-06 13:15:59 +01:00
parent d171c861c8
commit 357cf6e4ba
2 changed files with 25 additions and 8 deletions

View File

@ -1,8 +0,0 @@
Install Vagrant and Ansible each with version >= 2.0
Then, in this folder
$ vagrant up
...wait...
$ vagrant ssh
# cd /vermont
Here you find the vermont executable and the necessary config files under configs/

25
dev/README.md Normal file
View File

@ -0,0 +1,25 @@
# VERMONT VM
This vagrant setup provides an entry point for directly testing vermont without
further setup on a local machine.
It creates a VM which automatically installs all necessary dependecies for
vermont and builds the currently checked out version of it.
The repository is available in the VM via /vermont
## Setup
Install Vagrant and Ansible each with version >= 2.0.
Then, in this folder
``` shell
$ vagrant up
...wait...
$ vagrant ssh
# cd /vermont
# ./vermont -f <config-file>
```
## Build Configuration
The build process, its steps and parameters can be configured in
roles/base/tasks/main.yml