aboutsummaryrefslogtreecommitdiff
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 000000000..e4b870a64
--- /dev/null
+++ b/util/vagrant/readme.md
@@ -0,0 +1,12 @@
1# QMK Vagrant Utilities
2
3## Dockerfile
4Vagrant-friendly `qmkfm/base_container`.
5
6In order for the Docker provider and `vagrant ssh` to function the container has a few extra requirements.
7
8* vagrant user
9* ssh server
10 * configured with expected public key
11* sudo
12 * passwordless for vagrant user