From e38912515f24400cd7e3f6e0034959858890d4b4 Mon Sep 17 00:00:00 2001
From: Tom MacWright <tom@macwright.com>
Date: Sun, 1 Dec 2024 16:27:03 -0500
Subject: [PATCH] Improve readme and submodules

---
 .gitmodules |  6 +++---
 README.md   | 21 +++++++++++++++++++++
 2 files changed, 24 insertions(+), 3 deletions(-)

diff --git a/.gitmodules b/.gitmodules
index bd397b5..4dd38ac 100644
--- a/.gitmodules
+++ b/.gitmodules
@@ -6,11 +6,11 @@
 	url = https://github.com/webmproject/libwebp.git
 [submodule "components/esp-audio-player"]
 	path = components/esp-audio-player
-	url = git@github.com:chmorgan/esp-audio-player.git
+	url = https://github.com/chmorgan/esp-audio-player.git
 [submodule "components/esp-libhelix-mp3"]
 	path = components/esp-libhelix-mp3
-	url = git@github.com:chmorgan/esp-libhelix-mp3.git
+	url = https://github.com/chmorgan/esp-libhelix-mp3.git
 [submodule "lib/HUB75"]
 	path = lib/HUB75
-	url = git@github.com:tidbyt/ESP32-HUB75-MatrixPanel-I2S-DMA.git
+	url = https://github.com/tidbyt/ESP32-HUB75-MatrixPanel-I2S-DMA.git
 	branch = rohan/esp-idf-5
diff --git a/README.md b/README.md
index 87bfa21..683de60 100644
--- a/README.md
+++ b/README.md
@@ -9,11 +9,13 @@ This repository contains a community supported firmware for the Tidbyt hardware
 ![social banner](./docs/assets/social.png)
 
 ## Warning
+
 ⚠️ Warning! Flashing your Tidbyt with this firmware or derivatives could fatally 
 damage your device. As such, flashing your Tidbyt with this firmware or
 derivatives voids your warranty and comes without support.
 
 ## Setup
+
 This project uses PlatformIO to build, flash, and monitor firmware on the Tidbyt.
 To get started, you will need to download [PlatformIO Core][2] on your computer.
 
@@ -24,8 +26,17 @@ While we had pixlet in mind, you can point this firmware at any URL that hosts
 a WebP image that is optimized for the Tidbyt display.
 
 ## Getting Started
+
+This repository uses Git submodules, so make sure to specify the `--recurse-submodules`
+flag when cloning:
+
+```
+git clone --recurse-submodules https://github.com/tidbyt/hdk.git
+```
+
 To flash the custom firmware on your device, run the following after replacing
 the variables with your desired information:
+
 ```
 TIDBYT_WIFI_SSID='Your WiFi' \
 TIDBYT_WIFI_PASSWORD='super-secret' \
@@ -36,12 +47,21 @@ pio run --environment tidbyt --target upload
 If you're flashing to a Tidbyt Gen2, just change to the above to use
 the `--environment tidbyt-gen2` flag.
 
+**Note:** `TIDBYT_REMOTE_URL` must be an HTTP URL. This firmware **does not support HTTPS**
+for a remote URL.
+
 ## Monitoring Logs
+
 To check the output of your running firmware, run the following:
+
 ```
 pio device monitor
 ```
 
+**Note:** running `device monitor` at the same time as deploying new firmware
+with the `run` is not supported.
+
+
 ## Back to Normal
 To get your Tidbyt back to normal, you can run the following to flash the
 production firmware onto your Tidbyt:
@@ -56,5 +76,6 @@ And if you're working with a Tidbyt Gen 2:
 pio run --target reset --environment tidbyt-gen2
 ```
 
+
 [1]: https://github.com/tidbyt/pixlet
 [2]: https://docs.platformio.org/en/latest/core/installation/index.html