From 8ad6cc0abd6bb3eef5772cc935dbbfe09cffb90a Mon Sep 17 00:00:00 2001
From: Nathan Adams <nathanadams@icloud.com>
Date: Wed, 15 Jan 2020 18:02:44 +0000
Subject: [PATCH] make secrets ignored, and create a template file

---
 .gitignore                  | 75 +++++++++++++++++++++++++++++++++++++
 README.md                   | 24 +++++++++++-
 huzzah32/OSCIMU.ino         |  0
 huzzah32/secrets.template.h | 14 +++++++
 4 files changed, 112 insertions(+), 1 deletion(-)
 create mode 100644 .gitignore
 create mode 100644 huzzah32/OSCIMU.ino
 create mode 100644 huzzah32/secrets.template.h

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..ce093d9
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,75 @@
+## Project .gitignore
+
+huzzah32/secrets.h
+
+
+
+
+## Mac OS .gitignore
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+##Linux .gitignore
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+## Windows .gitignore
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
\ No newline at end of file
diff --git a/README.md b/README.md
index e6e8f6c..544ff79 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,25 @@
 # OscImu
 
-Wireless IMU that sends OSC messages - based on the HUZZAH32 and Fusion 9DoF breakout
\ No newline at end of file
+Wireless IMU that sends OSC messages - based on the HUZZAH32 and Fusion 9DoF breakout
+
+
+
+
+
+
+## Build Instructions
+
+### Hardware
+
+
+
+
+
+
+### Software
+
+Install the following Arduino libraries
+
+ESP32 (requires new path in Arduino preferences)
+OSC
+Adafruit Sensor Library
diff --git a/huzzah32/OSCIMU.ino b/huzzah32/OSCIMU.ino
new file mode 100644
index 0000000..e69de29
diff --git a/huzzah32/secrets.template.h b/huzzah32/secrets.template.h
new file mode 100644
index 0000000..37ee910
--- /dev/null
+++ b/huzzah32/secrets.template.h
@@ -0,0 +1,14 @@
+// OSC IMU 
+// Nathan Adams / Atau Tanaka - Goldsmiths, University of London
+// 2020
+
+// secrets.template.h
+//
+// Contains details used for Wireless and BT Connections - must never shared on github / gitlab etc
+// this actual file is included in .gitignore so it is never updated to avoid this.
+// When creating your own project copy secrets.template.h to secrets.h
+
+#define SECRET_SSID "******"
+#define SECRET_PASS "*******"
+#define SECRET_IP 172, 20, 10, 8
+#define SECRET_OUTPORT 9999
-- 
GitLab