From aceb08f93886babdc32f326be5a020db91180c1d Mon Sep 17 00:00:00 2001 From: Angus Gratton Date: Tue, 21 Mar 2017 15:37:17 +0800 Subject: [PATCH] docs: Mention the 'examples' dir in the setup docs --- docs/linux-setup.rst | 3 +++ docs/macos-setup.rst | 3 +++ docs/windows-setup.rst | 3 +++ 3 files changed, 9 insertions(+) diff --git a/docs/linux-setup.rst b/docs/linux-setup.rst index d3b8597cd4..bfcdf22f0e 100644 --- a/docs/linux-setup.rst +++ b/docs/linux-setup.rst @@ -142,6 +142,9 @@ 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. + +You can also find a range of example projects under the "examples" directory in IDF. These example project directories can be copied to outside IDF in order to begin your own projects. Step 4: Building and flashing the application ============================================= diff --git a/docs/macos-setup.rst b/docs/macos-setup.rst index e8f8257b28..33164f248d 100644 --- a/docs/macos-setup.rst +++ b/docs/macos-setup.rst @@ -130,6 +130,9 @@ 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. +You can also find a range of example projects under the "examples" directory in IDF. These example project directories can be copied to outside IDF in order to begin your own projects. + + Step 4: Building and flashing the application ============================================= diff --git a/docs/windows-setup.rst b/docs/windows-setup.rst index 9499b88b50..16b46732a7 100644 --- a/docs/windows-setup.rst +++ b/docs/windows-setup.rst @@ -50,6 +50,9 @@ The process is the same as for checking out the ESP-IDF from github. Change to t **IMPORTANT:** The esp-idf build system does not support spaces in paths to esp-idf or to projects. +You can also find a range of example projects under the "examples" directory in IDF. These example project directories can be copied to outside IDF in order to begin your own projects. + + Step 4: Configuring the project ===============================