From 567cabb3f5c926828d70bb7f12aabcfd338ac9d0 Mon Sep 17 00:00:00 2001 From: Angus Gratton Date: Fri, 16 Sep 2016 14:31:46 +1000 Subject: [PATCH] docs: Add note about esp-idf not supporting spaces in paths Ref Github #10 --- docs/linux-setup.rst | 1 + docs/macos-setup.rst | 1 + docs/windows-setup.rst | 2 ++ 3 files changed, 4 insertions(+) diff --git a/docs/linux-setup.rst b/docs/linux-setup.rst index ee9765156..13e1b3a9c 100644 --- a/docs/linux-setup.rst +++ b/docs/linux-setup.rst @@ -108,6 +108,7 @@ Note the ``--recursive`` option! If you have already cloned ESP-IDF without this cd ~/esp/esp-idf git submodule update --init +**IMPORTANT:** The esp-idf build system does not support spaces in paths to esp-idf or to projects. Step 3: Starting a project ========================== diff --git a/docs/macos-setup.rst b/docs/macos-setup.rst index d3869f426..8178a17ad 100644 --- a/docs/macos-setup.rst +++ b/docs/macos-setup.rst @@ -122,6 +122,7 @@ The easiest way to start a project is to download the template project from GitH This will download ``esp-idf-template`` project into ``~/esp/myapp`` directory. +**IMPORTANT:** The esp-idf build system does not support spaces in paths to esp-idf or to projects. Step 4: Building and flashing the application ============================================= diff --git a/docs/windows-setup.rst b/docs/windows-setup.rst index 89b134181..a368e3305 100644 --- a/docs/windows-setup.rst +++ b/docs/windows-setup.rst @@ -59,6 +59,8 @@ The easiest way to start a project is to download the Getting Started project fr The process is the same as for checking out the ESP-IDF from github. Change to the parent directory and run ``git clone https://github.com/espressif/esp-idf-template.git``. +**IMPORTANT:** The esp-idf build system does not support spaces in paths to esp-idf or to projects. + Step 4: Configuring the project ===============================