Esp‐idf - bounswe/bounswe2024group8 GitHub Wiki

Introduction

ESP-IDF is the development framework for Espressif SoCs(system-on-chips) supported on Windows, Linux and macOS.
esp-idf is the repository for ESP-IDF and it also includes common libraries such as esp-wifi and simple example projects such as blink. If you want to get more information about libraries you can see them under the components folder. Similarly, you can see the example projects under the examples folder.

What I like about the repository

• Most of the directories in the repository includes a readme file that includes useful information about the directories. This is very helpful for users of the repository because it helps them understand what is going on and also instructs them on usage of the repository components.
• The repository also has a good labeling system that is both helpful for the users of the repo and the developers of the repo. They have labels for bug report and feature requests that users can use while creating issues and they also have labels (Status: Opened, Status: In Progress, Resolution: Done, etc.) which shows information about the current situation of the issue and also about what will be done about the issue by the developers. I even added some labels I like from the repo to our repo such as Status: Pending and Status: In Progress as I think they may be useful in our project development.
• Issue management is also a good example for people that are new to github repositories. The repo includes more than a thousand open issues and approximately ten thousand closed issues which people can view and get familiar with github issues.

prepared by Onur Çerli