summaryrefslogtreecommitdiff
path: root/util/vagrant/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'util/vagrant/readme.md')
-rw-r--r--util/vagrant/readme.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/util/vagrant/readme.md b/util/vagrant/readme.md
new file mode 100644
index 0000000000..e4b870a642
--- /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