use_with_idf.md

Using with ESP-IDF

• 中文版

Table of Contents

• Using with ESP-IDF
  • Table of Contents
  • SDK & Dependencies
  • Adding to Project

SDK & Dependencies

Before using this library, please ensure you have installed the SDK that meets the following version requirements:

SDK	Version Required
esp-idf	>= 5.1

Note

• For SDK installation, please refer to ESP-IDF Programming Guide - Installation

Adding to Project

esp-boost has been uploaded to the Espressif Component Registry. You can add it to your project in the following ways:

1. Using Command Line

   Run the following command in your project directory:

   idf.py add-dependency "espressif/esp-boost==0.1.*"

2. Modifying Configuration File

   Create or modify the idf_component.yml file in your project directory:

   dependencies:
     espressif/esp-boost: "0.1.*"

For detailed information, please refer to Espressif Documentation - IDF Component Manager.