Merge pull request #9 from Flavourdynamics/patch-9

Update GettingStarted.md
ewowi · Jul 19, 2024 · 2715d13 · 2715d13
2 parents fd329f2 + 2ea37dc
commit 2715d13
Showing 1 changed file with 37 additions and 27 deletions.
diff --git a/docs/StarBase/GettingStarted.md b/docs/StarBase/GettingStarted.md
@@ -5,44 +5,54 @@ hide:
   # - toc
 ---
 
-## Getting Started
-
-* Download a firmware binary (bin)
-    * [StarBase release](https://github.com/ewowi/StarBase/releases) or [StarLight release](https://github.com/MoonModules/StarLight/releases)
-    * [StarBase latest](https://github.com/ewowi/StarBase/actions) or [StarLight latest](https://github.com/MoonModules/StarLight/actions)
-        * Click on the latest workflow run, scroll down to Artifacts, then download the bin file
-        * Currently only esp32dev builds can be found here
-    * Compile a bin using [StarBase source code](https://github.com/ewowi/StarBase) or [StarLight source code](https://github.com/MoonModules/StarLight) via [VSCode](https://code.visualstudio.com) and [PIO](https://platformio.org). 
-        * The following builds are available using VSCode:
+## Follow these steps to get StarMod and StarLight running
 
-        <img width="255" alt="image" src="https://github.com/ewowi/StarDocs/assets/138451817/cbd75a65-0046-4008-8670-ef97f4393b82">
+**1. Acquire a firmware binary (bin)**
 
-* Flash the unzipped "firmware.bin" to an ESP32 module using [ESP Flasher](https://github.com/srg74/WLED-wemos-shield/tree/master/resources/Firmware/WLED_%20ESP_Flasher)
-    * Unzip/extract the "firmware.bin" from the downloaded folder, then flash it to your connected ESP32 module
+Use a pre-built bin (Beginner-Advanced)
+
+* [StarBase release](https://github.com/ewowi/StarBase/releases) or [StarLight release](https://github.com/MoonModules/StarLight/releases)
+* [StarBase latest](https://github.com/ewowi/StarBase/actions) or [StarLight latest](https://github.com/MoonModules/StarLight/actions)
+* Click on the latest workflow run, scroll down to Artifacts, then download the bin file
+		* Currently only esp32dev builds can be found here
+
+Build your own bin (Intermediate-Advanced)
 
-<img width="716" alt="image" src="https://github.com/ewowi/StarDocs/assets/138451817/c8ab160d-bba0-4d5b-aed4-c858fea3637f">
+  * Compile a bin using [StarBase source code](https://github.com/ewowi/StarBase) or [StarLight source code](https://github.com/MoonModules/StarLight) via [VSCode](https://code.visualstudio.com) and [PIO](https://platformio.org). 
+        * The following builds are available using VSCode:
+
+	<img width="255" alt="image" src="https://github.com/ewowi/StarDocs/assets/138451817/cbd75a65-0046-4008-8670-ef97f4393b82">
 
-* Find the "StarBase" WiFi network and connect (no password needed)
+**2. Flash StarMod an ESP32 board**
 
-<img width="293" alt="image" src="https://github.com/ewowi/StarDocs/assets/138451817/e7b1e16a-8014-42dc-9e07-f4e0cbf04efd">
+* Flash the unzipped "firmware.bin" to an ESP32 module using [ESP Flasher](https://github.com/srg74/WLED-wemos-shield/tree/master/resources/Firmware/WLED_%20ESP_Flasher)
+* Unzip/extract the "firmware.bin" from the downloaded folder, then flash it to your connected ESP32 module
+
+	<img width="450" alt="image" src="https://github.com/ewowi/StarDocs/assets/138451817/c8ab160d-bba0-4d5b-aed4-c858fea3637f">
 
-* The StarMod adaptive portal will show the setup tab, alternatively go to [4.3.2.1](http://4.3.2.1)
+**3. Set up the StarMod instance**
+
+* Find the "StarBase" WiFi network broadcasted by the ESP32 and connect (no password needed)
 
-<img width="896" alt="image" src="https://github.com/ewowi/StarDocs/assets/138451817/cd8bd820-0a40-4ead-a0d2-14e0d0aa4ac3">
+	<img width="293" alt="image" src="https://github.com/ewowi/StarDocs/assets/138451817/e7b1e16a-8014-42dc-9e07-f4e0cbf04efd">
 
+* The StarMod adaptive portal will show the setup tab. Alternatively, go to [4.3.2.1](http://4.3.2.1)
+
+	<img width="450" alt="image" src="https://github.com/ewowi/StarDocs/assets/138451817/cd8bd820-0a40-4ead-a0d2-14e0d0aa4ac3">
+
 * Give the instance a name
-    * [System](/StarDocs/SysMod/SysModSystem)
-* Enter your Wifi credentials
-    * [Network](/StarDocs/SysMod/SysModNetwork)
-    * Note: first Save Model, then connect
+	* Read more: [System](/StarDocs/SysMod/SysModSystem)
+  
+* Enter your Wifi credentials (Do not hit connect yet)
+  * Read more: [Network](/StarDocs/SysMod/SysModNetwork)
 * Save Model
-    * [Model](/StarDocs/SysMod/SysModModel)
+  * Read more: [Model](/StarDocs/SysMod/SysModModel)
 * Reboot or press Connect
-* Connect to the WiFi network
-* Optionally, choose a display theme
-* Setup the application
-    * Continue here ! : [Setup StarLight](/StarDocs/StarLight/GettingStarted)
 
-## Update StarBase binary
+**4. Start using Starmod**
+  * Connect to the WiFi network
+  * [Configure StarLight](/StarDocs/StarLight/GettingStarted)
+
+## Updating the StarBase binary
 
 * See Ota Update in [System](/StarDocs/SysMod/SysModSystem)