diff --git a/README.md b/README.md new file mode 100644 index 0000000..bb65608 --- /dev/null +++ b/README.md @@ -0,0 +1,62 @@ +# Общая информация по проекту + +## STM32 (или STM-проект) + +Данный проект для STM был разработан и собран с использованием версии **1.18.1**. + +### Важно + +Для корректной работы и сборки проекта необходимо: + +* Установить **Repository (или SDK / пакет зависимостей) версии 1.18.1** +* Использовать строго ту же версию, так как проект не гарантирует совместимость с более новыми или старыми версиями + +--- + +## ESP32 (ESP-IDF проект) + +Проект для ESP32 разработан с использованием: + +* **Visual Studio Code (VS Code)** в качестве основной среды разработки +* **ESP-IDF framework версии v5.5.4** + +### Путь к установленному ESP-IDF: + +``` +C:\Espressif\frameworks\esp-idf-v5.5.4 +``` + +--- + +## Требования для сборки ESP32 проекта + +Перед сборкой необходимо: + +1. Установить Visual Studio Code +2. Установить расширение **ESP-IDF Extension for VS Code** +3. Убедиться, что ESP-IDF корректно установлен в системе: + + ``` + C:\Espressif\frameworks\esp-idf-v5.5.4 + ``` +4. Активировать окружение ESP-IDF перед сборкой (через VS Code или терминал) + +--- + +## Сборка проекта ESP32 + +В терминале проекта: + +```bash +idf.py build +idf.py flash +idf.py monitor +``` + +--- + +## Примечания + +* Версия ESP-IDF должна строго соответствовать **v5.5.4** +* Использование другой версии может привести к ошибкам компиляции или несовместимости компонентов +* Для STM проекта критична версия **1.18.1 Repository** \ No newline at end of file