alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

docs: Mention the 'examples' dir in the setup docs

Browse Source
This commit is contained in:
Angus Gratton 2017-03-21 15:37:17 +08:00
parent f5aee6a6e6
commit aceb08f938
3 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/linux-setup.rst
View File

@ -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. 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 Step 4: Building and flashing the application
============================================= =============================================

3
docs/macos-setup.rst
View File

@ -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. **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 Step 4: Building and flashing the application
============================================= =============================================

3
docs/windows-setup.rst
View File

@ -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. **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 Step 4: Configuring the project
=============================== ===============================