diff options
author | Elwin Hammer <elwinhamer@gmail.com> | 2024-05-21 20:52:34 +0200 |
---|---|---|
committer | Elwin Hammer <elwinhamer@gmail.com> | 2024-05-21 20:52:34 +0200 |
commit | a407d920293ebc1d442abcc5bb4e43fc8a6cbe65 (patch) | |
tree | d8b547abd753c9b28bd516bf6f68817e560e6b81 /main/puzzle/vault/esp-vaultpuzzle/README.md | |
parent | b73a609fad2a8e97ed9e708d9d91258b9ac1831c (diff) |
Feedback applied
Diffstat (limited to 'main/puzzle/vault/esp-vaultpuzzle/README.md')
-rw-r--r-- | main/puzzle/vault/esp-vaultpuzzle/README.md | 35 |
1 files changed, 0 insertions, 35 deletions
diff --git a/main/puzzle/vault/esp-vaultpuzzle/README.md b/main/puzzle/vault/esp-vaultpuzzle/README.md deleted file mode 100644 index 2bd3097..0000000 --- a/main/puzzle/vault/esp-vaultpuzzle/README.md +++ /dev/null @@ -1,35 +0,0 @@ -| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 | ESP32-P4 | ESP32-S2 | ESP32-S3 | -| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- | -------- | - -# _Sample project_ - -(See the README.md file in the upper level 'examples' directory for more information about examples.) - -This is the simplest buildable example. The example is used by command `idf.py create-project` -that copies the project to user specified path and set it's name. For more information follow the [docs page](https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/build-system.html#start-a-new-project) - - - -## How to use example -We encourage the users to use the example as a template for the new projects. -A recommended way is to follow the instructions on a [docs page](https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/build-system.html#start-a-new-project). - -## Example folder contents - -The project **sample_project** contains one source file in C language [main.c](main/main.c). 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 -(executable, library, or both). - -Below is short explanation of remaining files in the project folder. - -``` -├── CMakeLists.txt -├── main -│ ├── CMakeLists.txt -│ └── main.c -└── README.md This is the file you are currently reading -``` -Additionally, the sample project contains Makefile and component.mk files, used for the legacy Make based build system. -They are not used or needed when building with CMake and idf.py. |