diff --git a/README.md b/README.md index ab44558..b310e0c 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,8 @@ A reusable template for ESP32-S3 projects featuring WiFi connectivity and Over-T │ ├── wifi_manager.c/h # WiFi connection management │ ├── ota_server.c/h # OTA update server │ ├── led_strip.c/h # RGB LED driver -│ └── CMakeLists.txt # Component configuration +│ ├── CMakeLists.txt # Component configuration +| └── Kconfig.projbuild # To store wifi ssid and pass ├── partitions.csv # Flash partition table (4MB) ├── sdkconfig # Project configuration (auto-generated) ├── .gitignore # Git ignore rules @@ -47,10 +48,29 @@ A reusable template for ESP32-S3 projects featuring WiFi connectivity and Over-T git clone cd esp32-s3-template -# Edit WiFi credentials in main/main.c -#define WIFI_SSID "YourWiFiNetwork" -#define WIFI_PASSWORD "YourPassword" +# Create the file main/Kconfig.projbuild +touch main/Kconfig.projbuild ``` +Fill it in with the following: +``` +menu "Wi-Fi Configuration" + +config WIFI_SSID + string "WiFi SSID" + default "" + help + The SSID of the WiFi network. + +config WIFI_PASSWORD + string "WiFi Password" + default "" + help + The password of the WiFi network. + +endmenu +``` +Then fill in your SSID and Password + A new project can be started with: ```bash docker run --user $(id -u):$(id -g) --rm -v $PWD:/project -w /project -it espressif/idf:latest idf.py create-project