added comment to CMakeLists explaining ESP-IDF conditional

0xjmux · May 4, 2024 · 8623aa7 · 8623aa7
1 parent 3ce6f2f
commit 8623aa7
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,4 +1,6 @@
-# ESP-IDF component line
+
+# If we're building in ESP-IDF, register tetris as a component. 
+#   Does not run if we're building normally, (eg for testing on x86). 
 if(ESP_PLATFORM)
   idf_component_register(SRCS "tetris/tetris.c"
                       INCLUDE_DIRS "tetris")