From a6f0d24f6883ef030fde4b834bc3740a1bb16554 Mon Sep 17 00:00:00 2001 From: Greg J Preece Date: Tue, 28 May 2019 18:12:23 -0700 Subject: [PATCH] Documenting local Vagrant vs package Vagrant. --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index e4de36ff2..2c5c6ddb4 100644 --- a/README.md +++ b/README.md @@ -56,6 +56,15 @@ Once your Vagrant bundle is installed from Git repository, you can run the test This will run the unit test suite, which should come back all green! +If you are developing Vagrant on a machine that already has a Vagrant package installation present, both will attempt to use the same folder for their configuration (location of this folder depends on system). In this case, override the +`VAGRANT_HOME` environment variable for your development version of Vagrant before running any commands. For example, in Bash: + + export VAGRANT_HOME=/path/to/project/.vagrant + +This folder will be ignored by Git. You can now run Vagrant commands against the development version: + + bundle exec vagrant + Please take time to read the [HashiCorp Community Guidelines](https://www.hashicorp.com/community-guidelines) and the [Vagrant Contributing Guide](https://github.com/hashicorp/vagrant/blob/master/.github/CONTRIBUTING.md). Then you're good to go!