2024A-SW/managed_components/espressif__cmake_utilities/README.md

Cmake utilities

This component is aiming to provide some useful CMake utilities outside of ESP-IDF.

Use

1. Add dependency of this component in your component or project's idf_component.yml.

   dependencies:
     espressif/cmake_utilities: "0.*"
   

2. Include the CMake file you need in your component's CMakeLists.txt after idf_component_register, or in your project's CMakeLists.txt

   // Note: should remove .cmake postfix when using include(), otherwise the requested file will not found
   // Note: should place this line after `idf_component_register` function
   // only include the one you needed.
   include(package_manager)
   

3. Then you can use the corresponding CMake function which is provided by the CMake file.

Supported features

1. relinker
2. gen_compressed_ota
3. GCC Optimization