From 7d138244c449a6fe7a8dc864b1648710eb4b2d4f Mon Sep 17 00:00:00 2001 From: Lucas Saavedra Vaz <32426024+lucasssvaz@users.noreply.github.com> Date: Fri, 7 Jun 2024 10:41:38 -0300 Subject: [PATCH] change(idf): Rename component example --- idf_component.yml | 2 +- .../{Hello_world => hello_world}/CMakeLists.txt | 0 idf_component_examples/{Hello_world => hello_world}/README.md | 4 ++-- .../{Hello_world => hello_world}/main/CMakeLists.txt | 0 .../{Hello_world => hello_world}/main/idf_component.yml | 0 .../{Hello_world => hello_world}/main/main.cpp | 0 .../{Hello_world => hello_world}/sdkconfig.defaults | 0 7 files changed, 3 insertions(+), 3 deletions(-) rename idf_component_examples/{Hello_world => hello_world}/CMakeLists.txt (100%) rename idf_component_examples/{Hello_world => hello_world}/README.md (95%) rename idf_component_examples/{Hello_world => hello_world}/main/CMakeLists.txt (100%) rename idf_component_examples/{Hello_world => hello_world}/main/idf_component.yml (100%) rename idf_component_examples/{Hello_world => hello_world}/main/main.cpp (100%) rename idf_component_examples/{Hello_world => hello_world}/sdkconfig.defaults (100%) diff --git a/idf_component.yml b/idf_component.yml index bc987f25a93..3accad1fb9d 100644 --- a/idf_component.yml +++ b/idf_component.yml @@ -87,4 +87,4 @@ dependencies: version: "1.0.3" require: public examples: - - path: ./idf_component_examples/Hello_world + - path: ./idf_component_examples/hello_world diff --git a/idf_component_examples/Hello_world/CMakeLists.txt b/idf_component_examples/hello_world/CMakeLists.txt similarity index 100% rename from idf_component_examples/Hello_world/CMakeLists.txt rename to idf_component_examples/hello_world/CMakeLists.txt diff --git a/idf_component_examples/Hello_world/README.md b/idf_component_examples/hello_world/README.md similarity index 95% rename from idf_component_examples/Hello_world/README.md rename to idf_component_examples/hello_world/README.md index f666805dd8a..6e5f1e9acff 100644 --- a/idf_component_examples/Hello_world/README.md +++ b/idf_component_examples/hello_world/README.md @@ -12,13 +12,13 @@ To create a ESP-IDF project from this example with the latest release of Arduino ESP-IDF will download all dependencies needed from the component registry and setup the project for you. If you want to use cloned Arduino-esp32 repository, you can build this example directly. -Go to the example folder `arduino-esp32/idf_component_examples/Hello_world`. +Go to the example folder `arduino-esp32/idf_component_examples/hello_world`. First you need to comment line 6 `pre_release: true` in examples `/main/idf_component.yml`. Then just run command: `idf.py build`. ## Example folder contents -The project **Hello_world** contains one source file in C++ language [main.cpp](main/main.cpp). The file is located in folder [main](main). +The project **hello_world** contains one source file in C++ language [main.cpp](main/main.cpp). The file is located in folder [main](main). ESP-IDF projects are built using CMake. The project build configuration is contained in `CMakeLists.txt` files that provide set of directives and instructions describing the project's source files and targets diff --git a/idf_component_examples/Hello_world/main/CMakeLists.txt b/idf_component_examples/hello_world/main/CMakeLists.txt similarity index 100% rename from idf_component_examples/Hello_world/main/CMakeLists.txt rename to idf_component_examples/hello_world/main/CMakeLists.txt diff --git a/idf_component_examples/Hello_world/main/idf_component.yml b/idf_component_examples/hello_world/main/idf_component.yml similarity index 100% rename from idf_component_examples/Hello_world/main/idf_component.yml rename to idf_component_examples/hello_world/main/idf_component.yml diff --git a/idf_component_examples/Hello_world/main/main.cpp b/idf_component_examples/hello_world/main/main.cpp similarity index 100% rename from idf_component_examples/Hello_world/main/main.cpp rename to idf_component_examples/hello_world/main/main.cpp diff --git a/idf_component_examples/Hello_world/sdkconfig.defaults b/idf_component_examples/hello_world/sdkconfig.defaults similarity index 100% rename from idf_component_examples/Hello_world/sdkconfig.defaults rename to idf_component_examples/hello_world/sdkconfig.defaults