👣 Adds example configuration settings and updates readme

include/secrets.example.h

@@ -0,0 +1,24 @@
+// NOTE: do NOT enter your network details in this file (secrets.example.h)!
+// Instead, copy this file to secrets.h, and set the below defines in that file!
+
+#define HOSTNAME "leika"            // Relevant if wifi is enabled 
+#define SSID ""                     // Relevant if wifi is enabled 
+#define PASS ""                     // Relevant if wifi is enabled 
+
+#define HTTP_PORT 80                // Relevant if webserver is enabled 
+#define WEBSOCKET_PATH "/"          // Relevant if ws is enabled 
+
+#define CAMERA_MODEL_AI_THINKER     // Relevant if camera is enabled
+// #define CAMERA_MODEL_WROVER_KIT
+// #define CAMERA_MODEL_ESP_EYE
+// #define CAMERA_MODEL_M5STACK_PSRAM
+// #define CAMERA_MODEL_M5STACK_V2_PSRAM
+// #define CAMERA_MODEL_M5STACK_WIDE
+// #define CAMERA_MODEL_M5STACK_ESP32CAM
+// #define CAMERA_MODEL_M5STACK_UNITCAM
+// #define CAMERA_MODEL_TTGO_T_JOURNAL
+// #define CAMERA_MODEL_XIAO_ESP32S3
+// #define CAMERA_MODEL_ESP32_CAM_BOARD
+// #define CAMERA_MODEL_ESP32S3_CAM_LCD
+// #define CAMERA_MODEL_ESP32S2_CAM_BOARD
+// #define CAMERA_MODEL_ESP32S3_EYE

readme.md

@@ -207,6 +207,11 @@ The kinematic for the robot is from this [kinematics paper](https://www.research
     npm install
     ```
 
+1. Configure device settings
+    1. Make a copy of *include/secrets.example.h* in the same folder
+    2. Rename the copy to *secrets.h*
+    3. Configure relevant settings
+
 ## Usage
 
 ### Developing