Skip to content

Commit

Permalink
cmake docs: Specify feature/cmake branch when cloning from Github
Browse files Browse the repository at this point in the history
As mentioned here #1906 (comment)
  • Loading branch information
projectgus committed May 8, 2018
1 parent 81e48ca commit 829e6c4
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions docs/en/get-started/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ For Windows Command Prompt users, the equivalent commands are::

mkdir %userprofile%\esp
cd %userprofile%\esp
git clone --recursive https://github.com/espressif/esp-idf.git
git clone --branch feature/cmake --recursive https://github.com/espressif/esp-idf.git

.. highlight:: bash
.. note::
Expand All @@ -139,6 +139,12 @@ For Windows Command Prompt users, the equivalent commands are::
cd esp-idf
git submodule update --init

.. note::

The CMake-based build system preview uses a different Git branch to the default. This branch is ``feature/cmake``. If you missed the ``--branch`` option when cloning then you can switch branches on the command line::

cd esp-idf
git checkout feature/cmake

.. _get-started-setup-path:

Expand Down Expand Up @@ -211,7 +217,7 @@ For Windows Command Prompt users::
cd %userprofile%\esp
idf.py menuconfig

.. note:: If you get an error about ``idf.py`` not being found, check the ``tools`` directory is part of your Path as described above in :ref:`get-started-setup-path`.
.. note:: If you get an error about ``idf.py`` not being found, check the ``tools`` directory is part of your Path as described above in :ref:`get-started-setup-path`. If there is no ``idf.py`` in the ``tools`` directory, check you have the correct branch for the CMake preview as shown under :ref:`get-started-get-esp-idf`.

.. note:: Windows users, the Python 2.7 installer will try to configure Windows to associate files with a ``.py`` extension with Python 2. If a separate installed program (such as Visual Studio Python Tools) has created an association with a different version of Python, then running ``idf.py`` may not work. You can either run ``C:\Python27\python idf.py`` each time instead, or change the association that Windows uses for ``.py`` files.

Expand Down

0 comments on commit 829e6c4

Please sign in to comment.