From a56832c01c66eab8a59aa320d1fa4ad384702f75 Mon Sep 17 00:00:00 2001
From: Robert McMahon <rjmcmahon@rjmcmahon.com>
Date: Tue, 16 Dec 2025 18:14:40 -0800
Subject: [PATCH] build.txt file

---
 BUILD.txt | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 61 insertions(+)
 create mode 100644 BUILD.txt

diff --git a/BUILD.txt b/BUILD.txt
new file mode 100644
index 0000000..c0379be
--- /dev/null
+++ b/BUILD.txt
@@ -0,0 +1,61 @@
+# Developer Quick Start & Setup Guide
+
+This document outlines the steps to initialize the environment, install dependencies, configure the board, and build the generic shell firmware after a fresh `git clone`.
+
+## 1. Environment Initialization
+Before running any commands, load the ESP-IDF environment variables.
+
+### Option A: Standard Export
+```bash
+. $HOME/esp/esp-idf/export.sh
+
+export PATH=$PATH:~/.local/bin
+
+# ESP-IDF v6 activator
+get_idf() {
+  export IDF_PATH="$HOME/Code/esp32/esp-idf-v6"
+  export IDF_PYTHON_ENV_PATH="$HOME/.espressif/python_env/idf6.0_py3.11_env"
+  export IDF_TOOLS_PYTHON="$IDF_PYTHON_ENV_PATH/bin/python"
+  export PATH="$IDF_PYTHON_ENV_PATH/bin:$PATH"
+  export PYTHONNOUSERSITE=1
+  . "$IDF_PATH/export.sh"
+  hash -r
+  echo "ESP-IDF : $(idf.py --version 2>/dev/null)"
+  echo "python  : $(python --version)"
+  echo "idf.py  : $(command -v idf.py)"
+}
+
+# 1. Clone the repository
+git clone git@git.umbernetworks.com:/home/git/repos/esp32-iperf.git esp32-iperf-shell
+cd esp32-iperf-shell
+
+# 2. Checkout the generic shell feature branch
+git checkout -b feature/generic-shell origin/feature/generic-shell
+
+3. Install Dependencies (Crucial)
+This project relies on the led_strip component (v2.5.3+), which is managed by the IDF Component Manager. It is NOT included in the git repo by default and must be registered/downloaded before the first build.
+
+idf.py add-dependency "espressif/led_strip^2.5.3"
+
+4. Build Firmware
+You can build for a single target or verify all targets using the deployment script.
+
+Option A: Mass Build Verification (Recommended)
+This script builds all 12 combinations (Targets × CSI × AMPDU) to ensure no regressions.
+
+Batch Summary:
+  esp32      CSI:OFF AMPDU:OFF : PASS (13.3s)
+  ...
+  esp32s3    CSI:ON  AMPDU:ON  : PASS (14.2s)
+  esp32c5    CSI:ON  AMPDU:ON  : PASS (14.2s)
+
+
+# Set target (e.g., esp32s3, esp32c5)
+idf.py set-target esp32c5
+
+# Build
+idf.py build
+
+5. Monitor access
+
+idf.py -p /dev/ttyUSB0 monitor