From bbde0402afb3a9d1e71aa8ea610022bf3d4b7c41 Mon Sep 17 00:00:00 2001 From: Stanislav N Mikhailov Date: Sat, 2 May 2026 15:30:06 +0300 Subject: [PATCH] Add bilingual CMake configuration comments --- Examples/EngineDemo/CMakeLists.txt | 24 ++++++++++++++---------- Examples/Thermometr/CMakeLists.txt | 24 ++++++++++++++---------- README.md | 24 ++++++++++++++++-------- README.ru.md | 24 ++++++++++++++++-------- 4 files changed, 60 insertions(+), 36 deletions(-) diff --git a/Examples/EngineDemo/CMakeLists.txt b/Examples/EngineDemo/CMakeLists.txt index ebd9e63..7e1df86 100644 --- a/Examples/EngineDemo/CMakeLists.txt +++ b/Examples/EngineDemo/CMakeLists.txt @@ -1,6 +1,7 @@ cmake_minimum_required(VERSION 3.18.4) -# Change this line to switch target board manually: `pico` or `pico2`. +# EN: Change this line to switch the target board manually: `pico` for RP2040 or `pico2` for RP2350. +# RU: Измените эту строку, чтобы вручную переключить целевую плату: `pico` для RP2040 или `pico2` для RP2350. set(PICO_BOARD pico2 CACHE STRING "Pico SDK target board") include($ENV{PICO_SDK_PATH}/external/pico_sdk_import.cmake) @@ -37,19 +38,22 @@ target_link_libraries(display_engine PUBLIC pico_multicore ) -# Display pin mapping (single source of truth for this example). +# EN: Change the SPI bus, GPIO pins, and display controller here for this example. +# RU: Здесь изменяются SPI-шина, GPIO-пины и контроллер дисплея для этого примера. set(DISPLAY_SPI_PORT spi1) -set(DISPLAY_PIN_MOSI 15) -set(DISPLAY_PIN_SCK 14) -set(DISPLAY_PIN_CS 13) -set(DISPLAY_PIN_DC 12) -set(DISPLAY_PIN_RST 11) -set(DISPLAY_PIN_BL 10) -# Available values: DISPLAY_TYPE_ST7789, DISPLAY_TYPE_ILI9341 +set(DISPLAY_PIN_MOSI 15) # DIN / SDA +set(DISPLAY_PIN_SCK 14) # CLK / SCL / SCK +set(DISPLAY_PIN_CS 13) # CS / SS +set(DISPLAY_PIN_DC 12) # DC / A0 / RS +set(DISPLAY_PIN_RST 11) # RST / RES / RESET +set(DISPLAY_PIN_BL 10) # BL / LED / LEDK +# EN: Available values: DISPLAY_TYPE_ST7789, DISPLAY_TYPE_ILI9341. +# RU: Доступные значения: DISPLAY_TYPE_ST7789, DISPLAY_TYPE_ILI9341. set(DISPLAY_TYPE "DISPLAY_TYPE_ST7789" CACHE STRING "Display controller backend") set_property(CACHE DISPLAY_TYPE PROPERTY STRINGS DISPLAY_TYPE_ST7789 DISPLAY_TYPE_ILI9341) -# Pass display mapping into display backend without editing engine sources. +# EN: These definitions forward the selected board wiring into the display engine without editing its sources. +# RU: Эти определения передают выбранную разводку платы в display engine без правки его исходников. target_compile_definitions(display_engine PUBLIC DISPLAY_TYPE=${DISPLAY_TYPE} DISPLAY_SPI_PORT=${DISPLAY_SPI_PORT} diff --git a/Examples/Thermometr/CMakeLists.txt b/Examples/Thermometr/CMakeLists.txt index f5b7e65..4de19d3 100644 --- a/Examples/Thermometr/CMakeLists.txt +++ b/Examples/Thermometr/CMakeLists.txt @@ -1,6 +1,7 @@ cmake_minimum_required(VERSION 3.18.4) -# Change this line to switch target board manually: `pico` or `pico2`. +# EN: Change this line to switch the target board manually: `pico` for RP2040 or `pico2` for RP2350. +# RU: Измените эту строку, чтобы вручную переключить целевую плату: `pico` для RP2040 или `pico2` для RP2350. set(PICO_BOARD pico2 CACHE STRING "Pico SDK target board") include($ENV{PICO_SDK_PATH}/external/pico_sdk_import.cmake) @@ -37,19 +38,22 @@ target_link_libraries(display_engine PUBLIC pico_multicore ) -# Display pin mapping (single source of truth for this example). +# EN: Change the SPI bus, GPIO pins, and display controller here for this example. +# RU: Здесь изменяются SPI-шина, GPIO-пины и контроллер дисплея для этого примера. set(DISPLAY_SPI_PORT spi1) -set(DISPLAY_PIN_MOSI 15) -set(DISPLAY_PIN_SCK 14) -set(DISPLAY_PIN_CS 13) -set(DISPLAY_PIN_DC 12) -set(DISPLAY_PIN_RST 11) -set(DISPLAY_PIN_BL 10) -# Available values: DISPLAY_TYPE_ST7789, DISPLAY_TYPE_ILI9341 +set(DISPLAY_PIN_MOSI 15) # DIN / SDA +set(DISPLAY_PIN_SCK 14) # CLK / SCL / SCK +set(DISPLAY_PIN_CS 13) # CS / SS +set(DISPLAY_PIN_DC 12) # DC / A0 / RS +set(DISPLAY_PIN_RST 11) # RST / RES / RESET +set(DISPLAY_PIN_BL 10) # BL / LED / LEDK +# EN: Available values: DISPLAY_TYPE_ST7789, DISPLAY_TYPE_ILI9341. +# RU: Доступные значения: DISPLAY_TYPE_ST7789, DISPLAY_TYPE_ILI9341. set(DISPLAY_TYPE "DISPLAY_TYPE_ILI9341" CACHE STRING "Display controller backend") set_property(CACHE DISPLAY_TYPE PROPERTY STRINGS DISPLAY_TYPE_ST7789 DISPLAY_TYPE_ILI9341) -# Pass display mapping into display backend without editing engine sources. +# EN: These definitions forward the selected board wiring into the display engine without editing its sources. +# RU: Эти определения передают выбранную разводку платы в display engine без правки его исходников. target_compile_definitions(display_engine PUBLIC DISPLAY_TYPE=${DISPLAY_TYPE} DISPLAY_SPI_PORT=${DISPLAY_SPI_PORT} diff --git a/README.md b/README.md index 0073e2a..209abd3 100644 --- a/README.md +++ b/README.md @@ -78,7 +78,8 @@ Create the root `CMakeLists.txt`: cat > CMakeLists.txt <<'EOF' cmake_minimum_required(VERSION 3.18.4) -# Change to `pico` for RP2040-based boards or keep `pico2` for Pico 2 / RP2350. +# EN: Change to `pico` for RP2040-based boards or keep `pico2` for Pico 2 / RP2350. +# RU: Замените на `pico` для плат на RP2040 или оставьте `pico2` для Pico 2 / RP2350. set(PICO_BOARD pico2 CACHE STRING "Pico SDK target board") include($ENV{PICO_SDK_PATH}/external/pico_sdk_import.cmake) @@ -98,7 +99,8 @@ add_library(display_engine STATIC ${DISPLAY_ENGINE_DIR}/src/core/display_driver.c ${DISPLAY_ENGINE_DIR}/src/render/context.c ${DISPLAY_ENGINE_DIR}/src/render/line.c - # Uncomment if/when you need these primitives: + # EN: Uncomment these sources if/when you need the extra primitives. + # RU: Раскомментируйте эти исходники, если понадобятся дополнительные примитивы. # ${DISPLAY_ENGINE_DIR}/src/render/grid.c # ${DISPLAY_ENGINE_DIR}/src/render/sine_wave.c # ${DISPLAY_ENGINE_DIR}/src/render/bezier.c @@ -117,15 +119,21 @@ target_link_libraries(display_engine PUBLIC pico_multicore ) +# EN: Change the SPI bus, GPIO pins, and display controller here to match your wiring. +# RU: Здесь измените SPI-шину, GPIO-пины и контроллер дисплея под вашу схему подключения. target_compile_definitions(display_engine PUBLIC + # EN: Select the display controller backend: ST7789 or ILI9341. + # RU: Выберите бэкенд контроллера дисплея: ST7789 или ILI9341. DISPLAY_TYPE=DISPLAY_TYPE_ST7789 + # EN: Select the SPI peripheral connected to the display: spi0 or spi1. + # RU: Выберите SPI-периферию, к которой подключён дисплей: spi0 или spi1. DISPLAY_SPI_PORT=spi1 - DISPLAY_PIN_MOSI=15 - DISPLAY_PIN_SCK=14 - DISPLAY_PIN_CS=13 - DISPLAY_PIN_DC=12 - DISPLAY_PIN_RST=11 - DISPLAY_PIN_BL=10 + DISPLAY_PIN_MOSI=15 # DIN / SDA + DISPLAY_PIN_SCK=14 # CLK / SCL / SCK + DISPLAY_PIN_CS=13 # CS / SS + DISPLAY_PIN_DC=12 # DC / A0 / RS + DISPLAY_PIN_RST=11 # RST / RES / RESET + DISPLAY_PIN_BL=10 # BL / LED / LEDK ) add_executable(my_app src/main.c) diff --git a/README.ru.md b/README.ru.md index 8c67e7a..7a744c1 100644 --- a/README.ru.md +++ b/README.ru.md @@ -78,7 +78,8 @@ export PICO_SDK_PATH=/absolute/path/to/pico-sdk cat > CMakeLists.txt <<'EOF' cmake_minimum_required(VERSION 3.18.4) -# Замените на `pico` для плат на RP2040 или оставьте `pico2` для Pico 2 / RP2350. +# EN: Change to `pico` for RP2040-based boards or keep `pico2` for Pico 2 / RP2350. +# RU: Замените на `pico` для плат на RP2040 или оставьте `pico2` для Pico 2 / RP2350. set(PICO_BOARD pico2 CACHE STRING "Pico SDK target board") include($ENV{PICO_SDK_PATH}/external/pico_sdk_import.cmake) @@ -98,7 +99,8 @@ add_library(display_engine STATIC ${DISPLAY_ENGINE_DIR}/src/core/display_driver.c ${DISPLAY_ENGINE_DIR}/src/render/context.c ${DISPLAY_ENGINE_DIR}/src/render/line.c - # Раскомментируйте при необходимости: + # EN: Uncomment these sources if/when you need the extra primitives. + # RU: Раскомментируйте эти исходники, если понадобятся дополнительные примитивы. # ${DISPLAY_ENGINE_DIR}/src/render/grid.c # ${DISPLAY_ENGINE_DIR}/src/render/sine_wave.c # ${DISPLAY_ENGINE_DIR}/src/render/bezier.c @@ -117,15 +119,21 @@ target_link_libraries(display_engine PUBLIC pico_multicore ) +# EN: Change the SPI bus, GPIO pins, and display controller here to match your wiring. +# RU: Здесь измените SPI-шину, GPIO-пины и контроллер дисплея под вашу схему подключения. target_compile_definitions(display_engine PUBLIC + # EN: Select the display controller backend: ST7789 or ILI9341. + # RU: Выберите бэкенд контроллера дисплея: ST7789 или ILI9341. DISPLAY_TYPE=DISPLAY_TYPE_ST7789 + # EN: Select the SPI peripheral connected to the display: spi0 or spi1. + # RU: Выберите SPI-периферию, к которой подключён дисплей: spi0 или spi1. DISPLAY_SPI_PORT=spi1 - DISPLAY_PIN_MOSI=15 - DISPLAY_PIN_SCK=14 - DISPLAY_PIN_CS=13 - DISPLAY_PIN_DC=12 - DISPLAY_PIN_RST=11 - DISPLAY_PIN_BL=10 + DISPLAY_PIN_MOSI=15 # DIN / SDA + DISPLAY_PIN_SCK=14 # CLK / SCL / SCK + DISPLAY_PIN_CS=13 # CS / SS + DISPLAY_PIN_DC=12 # DC / A0 / RS + DISPLAY_PIN_RST=11 # RST / RES / RESET + DISPLAY_PIN_BL=10 # BL / LED / LEDK ) add_executable(my_app src/main.c)