From bf852ffc81f82039133023069fe6827f7313cdc7 Mon Sep 17 00:00:00 2001 From: Quinn Date: Tue, 20 Aug 2024 18:12:00 -0400 Subject: [PATCH] Added note to readme about initializing submodules --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0cf8eaa..10dc64f 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,11 @@ When the physical user removes a block from the board, the corresponding digital When the VR user hovers over or picks up a digital cube, the corresponding physical cube changes color to show the physical user what the VR user is doing. ## Setup +### Repository Setup +When the repository is first cloned you will need to initialize all of its submodules. + +In the terminal type: `git submodule update --init --recursive` which will initalize all of the submodules. + ### Board Assemble #### Parts List - Foam core (scavenged) @@ -53,7 +58,7 @@ wiring diagram for the cube is in the `documentation` directory. - Arduino libraries ### Bluetooth Module -On v0.1 of the baord, a seperate bluetooth module (HC-05) is being used for bluetooth. This module needs to be programmed when first plugged in. To program the module, disconnect it from power and hold the "EN" button on the module. (The button should be the only button on the HC-05 module). While still holding down the button, reconnect the module to the ESP32 and press the ESP32's reset button. Wait 5 seconds while still holding down the "EN" button on the module, then release the button, power cycle the module, and you're done. +On v0.1 of the board, a seperate bluetooth module (HC-05) is being used for bluetooth. This module needs to be programmed when first plugged in. To program the module, disconnect it from power and hold the "EN" button on the module. (The button should be the only button on the HC-05 module). While still holding down the button, reconnect the module to the ESP32. Let go of the button and then press the ESP32's reset button. Wait 5 seconds while still holding down the "EN" button on the module, then release the button, power cycle the module, and you're done. ## Run - Power up the board and pair it with the headset over bluetooth.