esp-idf/examples/get-started/sample_project

Sample project

(For general overview of examples and their usage, see the README.md file in the upper level 'examples' directory.)

[!NOTE] After you click any link to ESP-IDF Programming Guide, go to the top of the sidebar, then make sure you have the appropriate Espressif chip (target) and ESP-IDF version selected in the dropdown menus.

This is the example of a simplest buildable project. It is also used by the command idf.py create-project which copies these files to the path specified by the user and sets the project name.

This sample projects contains:

├── CMakeLists.txt  # Build configuration declaring entire project
├── main
│   ├── CMakeLists.txt  # File that registers the main component
│   └── main.c          # Source file for the main component
└── README.md           # File you are currently browsing

If you want to develop a project for the legacy build system based on Make that requires Makefile and component.mk files, see esp-idf-template.

Usage

For brief instructions on how to configure, build, and flash the project, see Examples README > Using Examples.

Further Development

For further steps on how to develop the project, see the following:

• Managing the project:
  • IDF Frontend document
  • ESP-IDF Getting Started video (YouTube, bilibili)
  • Overview of an example project
  • Build System document
• Writing code:
  • Find appropriate bits of code in application examples
  • Write your own code following the API references

Documentation

If you want to contribute this project as an ESP-IDF application example, please write this README based on the example README template.