esp-idf/tools/docker
Peter Dragun 16d033a919 tools: Docker: add build-essentials needed for linux targets
Closes https://github.com/espressif/esp-idf/pull/10772
2023-02-28 11:27:25 +01:00
..
Dockerfile tools: Docker: add build-essentials needed for linux targets 2023-02-28 11:27:25 +01:00
README.md tools/docker: add README.md file to be displayed on Docker Hub 2022-05-26 03:44:13 +02:00
entrypoint.sh

README.md

ESP-IDF Docker Image

This is a Docker image for the Espressif IoT Development Framework (ESP-IDF). It is intended for building applications and libraries with specific versions of ESP-IDF, when doing automated builds.

This image contains a copy of ESP-IDF and all the tools necessary to build ESP-IDF projects.

Tags

Multiple tags of this image are maintained:

  • latest: tracks master branch of ESP-IDF
  • vX.Y: corresponds to ESP-IDF release vX.Y
  • release-vX.Y: tracks release/vX.Y branch of ESP-IDF

Basic Usage

Build a project located in the current directory using idf.py build command:

docker run --rm -v $PWD:/project -w /project espressif/idf:latest idf.py build

Documentation

For more information about this image and the detailed usage instructions, please refer to the ESP-IDF Programming Guide page: IDF Docker Image.