added esp project

[matrix_esp_thesis] / esp32 / esp_project / README.md

diff --git a/esp32/esp_project/README.md b/esp32/esp_project/README.md
new file mode 100644 (file)
index 0000000..079f444
--- /dev/null
+++ b/esp32/esp_project/README.md
@@ -0,0 +1,53 @@
+| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 | ESP32-S2 | ESP32-S3 |\r
+| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- |\r
+\r
+# Hello World Example\r
+\r
+Starts a FreeRTOS task to print "Hello World".\r
+\r
+(See the README.md file in the upper level 'examples' directory for more information about examples.)\r
+\r
+## How to use example\r
+\r
+Follow detailed instructions provided specifically for this example.\r
+\r
+Select the instructions depending on Espressif chip installed on your development board:\r
+\r
+- [ESP32 Getting Started Guide](https://docs.espressif.com/projects/esp-idf/en/stable/get-started/index.html)\r
+- [ESP32-S2 Getting Started Guide](https://docs.espressif.com/projects/esp-idf/en/latest/esp32s2/get-started/index.html)\r
+\r
+\r
+## Example folder contents\r
+\r
+The project **hello_world** contains one source file in C language [hello_world_main.c](main/hello_world_main.c). The file is located in folder [main](main).\r
+\r
+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).\r
+\r
+Below is short explanation of remaining files in the project folder.\r
+\r
+```\r
+├── CMakeLists.txt\r
+├── pytest_hello_world.py      Python script used for automated testing\r
+├── main\r
+│   ├── CMakeLists.txt\r
+│   └── hello_world_main.c\r
+└── README.md                  This is the file you are currently reading\r
+```\r
+\r
+For more information on structure and contents of ESP-IDF projects, please refer to Section [Build System](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/build-system.html) of the ESP-IDF Programming Guide.\r
+\r
+## Troubleshooting\r
+\r
+* Program upload failure\r
+\r
+    * Hardware connection is not correct: run `idf.py -p PORT monitor`, and reboot your board to see if there are any output logs.\r
+    * The baud rate for downloading is too high: lower your baud rate in the `menuconfig` menu, and try again.\r
+\r
+## Technical support and feedback\r
+\r
+Please use the following feedback channels:\r
+\r
+* For technical queries, go to the [esp32.com](https://esp32.com/) forum\r
+* For a feature request or bug report, create a [GitHub issue](https://github.com/espressif/esp-idf/issues)\r
+\r
+We will get back to you as soon as possible.\r