Configure Vagrant to use qmk_base_container (#6194)

[qmk_firmware.git] / util / vagrant / readme.md

diff --git a/util/vagrant/readme.md b/util/vagrant/readme.md
new file mode 100644 (file)
index 0000000..e4b870a
--- /dev/null
+++ b/util/vagrant/readme.md
@@ -0,0 +1,12 @@
+# QMK Vagrant Utilities
+
+## Dockerfile
+Vagrant-friendly `qmkfm/base_container`.
+
+In order for the Docker provider and `vagrant ssh` to function the container has a few extra requirements.
+
+* vagrant user
+* ssh server
+  * configured with expected public key
+* sudo
+  * passwordless for vagrant user