From efa8ed2b3d36f808787c5a61f091e6d201316411 Mon Sep 17 00:00:00 2001
From: Yvan <yvan@funnyfarm.bogalow>
Date: Mon, 17 Mar 2025 17:36:56 +0000
Subject: [PATCH] add README to explain setting the wifi network/pass, also
 remove .gitignore line as that doesn't work properly, the README gives a
 better alternative.

---
 src/secrets/README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
 create mode 100644 src/secrets/README.md

diff --git a/src/secrets/README.md b/src/secrets/README.md
new file mode 100644
index 0000000..0d8e151
--- /dev/null
+++ b/src/secrets/README.md
@@ -0,0 +1,17 @@
+# Secret Stuff!
+
+To set your wifi network and password put them into the relevant files but
+without a trailing newling. I.e.
+
+```
+echo -n "my-wifi-network" > src/secrets/wifi-network
+echo -n "some password" > src/secrets/wifi-password
+```
+
+This command can then be used to ensure changes don't get checked in:
+
+```
+git update-index --assume-unchanged src/secrets/wifi-network
+git update-index --assume-unchanged src/secrets/wifi-password
+```
+