Anton Maklakov afbaf74007 tools: Mass fixing of empty prototypes (for -Wstrict-prototypes) %!s(int64=6) %!d(string=hai) anos
..
cmdlinerunner afbaf74007 tools: Mass fixing of empty prototypes (for -Wstrict-prototypes) %!s(int64=6) %!d(string=hai) anos
.gitignore 04d24c750a tools: new installer for Windows %!s(int64=6) %!d(string=hai) anos
README.md 04d24c750a tools: new installer for Windows %!s(int64=6) %!d(string=hai) anos
build_installer.sh da0f9717be Sign IDF Tools installer with 'osslsigncode', update to V1.2 %!s(int64=7) %!d(string=hai) anos
choice_page.iss.inc 04d24c750a tools: new installer for Windows %!s(int64=6) %!d(string=hai) anos
cmdline_page.iss.inc 04d24c750a tools: new installer for Windows %!s(int64=6) %!d(string=hai) anos
git_find_installed.iss.inc 04d24c750a tools: new installer for Windows %!s(int64=6) %!d(string=hai) anos
git_page.iss.inc 04d24c750a tools: new installer for Windows %!s(int64=6) %!d(string=hai) anos
idf_cmd_init.bat aaf3dcbda0 tools: installer: fix quoting of IDF_TOOLS_PATH %!s(int64=6) %!d(string=hai) anos
idf_download_page.iss.inc 9c5284e7b5 tools: installer: verify that IDF_PATH doesn't contain spaces %!s(int64=6) %!d(string=hai) anos
idf_page.iss.inc 9c5284e7b5 tools: installer: verify that IDF_PATH doesn't contain spaces %!s(int64=6) %!d(string=hai) anos
idf_setup.iss.inc aaf3dcbda0 tools: installer: fix quoting of IDF_TOOLS_PATH %!s(int64=6) %!d(string=hai) anos
idf_tool_setup.iss 80ad09f230 tools: installer: allow changing installation path %!s(int64=6) %!d(string=hai) anos
license.txt efd62a50b9 windows: Add License (GPL) display to IDF Tools installer %!s(int64=7) %!d(string=hai) anos
main.iss.inc 80ad09f230 tools: installer: allow changing installation path %!s(int64=6) %!d(string=hai) anos
python_find_installed.iss.inc 04d24c750a tools: new installer for Windows %!s(int64=6) %!d(string=hai) anos
python_page.iss.inc 04d24c750a tools: new installer for Windows %!s(int64=6) %!d(string=hai) anos
summary.iss.inc 04d24c750a tools: new installer for Windows %!s(int64=6) %!d(string=hai) anos
tools_fallback.json e6e1792946 tools: update idf_exe to 1.0.1 %!s(int64=6) %!d(string=hai) anos
utils.iss.inc 04d24c750a tools: new installer for Windows %!s(int64=6) %!d(string=hai) anos

README.md

ESP-IDF Tools Installer for Windows

This directory contains source files required to build the tools installer for Windows.

The installer is built using Inno Setup. At the time of writing, the installer can be built with Inno Setup version 6.0.2.

The main source file of the installer is idf_tools_setup.iss. PascalScript code is split into multiple *.iss.inc files.

Some functionality of the installer depends on additional programs:

  • Inno Download Plugin — used to download additional files during the installation.

  • 7-zip — used to extract downloaded IDF archives.

  • cmdlinerunner — a helper DLL used to run external command line programs from the installer, capture live console output, and get the exit code.

Steps required to build the installer

  • Build cmdlinerunner DLL.

    • On Linux/Mac, install mingw-w64 toolchain (i686-w64-mingw32-gcc). Then build the DLL using CMake:

      mkdir -p cmdlinerunner/build
      cd cmdlinerunner/build
      cmake -DCMAKE_TOOLCHAIN_FILE=../toolchain-i686-w64-mingw32.cmake -DCMAKE_BUILD_TYPE=Release ..
      cmake --build .
      

      This will produce cmdlinerunner.dll in the build directory.

    • On Windows, it is possible to build using Visual Studio, with CMake support installed. By default, VS produces build artifacts in some hard to find directory. You can adjust this in CmakeSettings.json file generated by VS.

  • Download 7zip.exe ("standalone console version") and put it into unzip directory (to get unzip/7za.exe).

  • Download idf_versions.txt and place it into the current directory. The installer will use it as a fallback, if it can not download idf_versions.txt at run time.

  • Create the dist directory and populate it with the tools which should be bundled with the installer. At the moment the easiest way to obtain it is to use install.sh/install.bat in IDF, and then copy the contents of $HOME/.espressif/dist directory. If the directory is empty, the installer should still work, and the tools will be downloaded during the installation.

  • Build the installer using Inno Setup Compiler: ISCC.exe idf_tools_setup.iss.

  • Obtain the signing keys, then sign Output/esp-idf-tools-setup-unsigned.exe.