aboutsummaryrefslogtreecommitdiff
path: root/ports/esp32/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'ports/esp32/README.md')
-rw-r--r--ports/esp32/README.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/ports/esp32/README.md b/ports/esp32/README.md
index 85df001e3..0e6531db8 100644
--- a/ports/esp32/README.md
+++ b/ports/esp32/README.md
@@ -78,7 +78,7 @@ ESPIDF = <path to root of esp-idf repository>
#FLASH_MODE = qio
#FLASH_SIZE = 4MB
#CROSS_COMPILE = xtensa-esp32-elf-
-#CONFIG_SPIRAM_SUPPORT = 1
+#SDKCONFIG = boards/sdkconfig.spiram
include Makefile
```
@@ -92,6 +92,17 @@ are `PORT` for the serial port of your esp32 module, and `FLASH_MODE`
(which may need to be `dio` for some modules)
and `FLASH_SIZE`. See the Makefile for further information.
+The default ESP IDF configuration settings are provided in the file
+`boards/sdkconfig`, and this file is specified in the build by the make
+variable `SDKCONFIG`. To use a custom configuration either set `SDKCONFIG`
+in your custom `makefile` (or `GNUmakefile`) or set this variable on the
+command line:
+```bash
+$ make SDKCONFIG=sdkconfig.myboard
+```
+The file `boards/sdkconfig.spiram` is provided for ESP32 modules that have
+external SPIRAM.
+
Building the firmware
---------------------