From eeaaed52200bb27d6018407fd5144f6480c3facb Mon Sep 17 00:00:00 2001
From: cheezedoodle2 <cheezedoodle2@users.noreply.github.com>
Date: Wed, 7 Jun 2023 17:28:16 -0700
Subject: [PATCH] Commented the run script, added instructions for running
 under WSL

---
 README.md         | 18 ++++++++++++++++++
 docker/dev/run.sh |  1 +
 2 files changed, 19 insertions(+)

diff --git a/README.md b/README.md
index eb4d684..f184ba1 100644
--- a/README.md
+++ b/README.md
@@ -18,3 +18,21 @@ You will also have to log into GCP *twice*, once for the gcloud CLI tools,
 and again for the GCP SDK libraries:
 
 https://googleapis.dev/python/google-api-core/latest/auth.html
+
+Windows hosts need to use WSL as the ansible client.  Ubuntu doesn't have a
+ssh-agent manager by default, so it's recommended to install keychain:
+
+`apt install keychain`
+`echo 'eval $(keychain -q --eval) >> ~/.bashrc` 
+
+Allow WSL distributions to use NTFS metadata for storing Linux ACLs:
+
+* Add to /etc/wsl.conf:
+```
+[automount]
+options = "metadata"
+```
+
+* Restart wsl
+
+* chmod 755 the ansible directory
\ No newline at end of file
diff --git a/docker/dev/run.sh b/docker/dev/run.sh
index 2096765..dbdc5ba 100755
--- a/docker/dev/run.sh
+++ b/docker/dev/run.sh
@@ -1,2 +1,3 @@
 #!/bin/bash
+# Run the docker container
 docker run -p 2222:22 -d dev