esp-idf/docs/en/get-started/macos-setup.rst

**********************************************
Standard Setup of Toolchain for Mac OS
**********************************************

:link_to_translation:`zh_CN:[中文]`

Install Prerequisites
=====================

ESP-IDF will use the version of Python installed by default on macOS.

- install pip::

    sudo easy_install pip

- install CMake & Ninja build:

  - If you have HomeBrew_, you can run::

      brew install cmake ninja dfu-util

  - If you have MacPorts_, you can run::

      sudo port install cmake ninja dfu-util

  - Otherwise, consult the CMake_ and Ninja_ home pages for macOS installation downloads.

- It is strongly recommended to also install ccache_ for faster builds. If you have HomeBrew_, this can be done via ``brew install ccache`` or ``sudo port install ccache`` on MacPorts_.

.. note::
   If an error like this is shown during any step::

     xcrun: error: invalid active developer path (/Library/Developer/CommandLineTools), missing xcrun at: /Library/Developer/CommandLineTools/usr/bin/xcrun

   Then you will need to install the XCode command line tools to continue. You can install these by running ``xcode-select --install``.

Installing and setting up Python 3 as default
---------------------------------------------

Basing on macOS `Catalina 10.15 release notes`_, use of Python 2.7 is not recommended and Python will not be included by default in future versions of macOS. Check what Python you currently have::

  python --version

If the output is like ``Python 2.7.17``, your default interpreter is Python 2.7. If so, also check if Python 3 isn't already installed on your computer::

  python3 --version

If above command returns an error, it means Python 3 is not installed. 

Below is an overview of steps to install Python 3 and making it default interpreter. 

  - Installing with HomeBrew_ can be done as follows::

      brew install python3
      ln -s /usr/local/bin/python3.8 /usr/local/bin/python

    Adjust above directory name ``/usr/local/bin/python3.8`` to point where Python 3 has been installed. To check this directory you can run  ``which -a python``.

  - If you have MacPorts_, you can run::

      sudo port install python38
      sudo port select --set python python38

Now open a new terminal session to verify what python is running by default::

  python --version

If the output is similar to ``Python 3.8.5``, your installation has been done successfully.


.. note::

    This is system-wide change which may affect all of the applications.

Next Steps
==========

To carry on with development environment setup, proceed to :ref:`get-started-get-esp-idf`.


.. _cmake: https://cmake.org/
.. _ninja: https://ninja-build.org/
.. _ccache: https://ccache.samba.org/
.. _homebrew: https://brew.sh/
.. _MacPorts: https://www.macports.org/install.php
.. _Catalina 10.15 release notes: https://developer.apple.com/documentation/macos-release-notes/macos-catalina-10_15-release-notes
docs: Make CMake build system default, mark GNU Make as legacy option All `-cmake` suffixes are removed Where a GNU Make option is renamed, the `-legacy` suffix is used 2019-06-24 21:26:53 -04:00			`**********************************************`
			`Standard Setup of Toolchain for Mac OS`
			`**********************************************`
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be) 2019-06-24 21:29:49 -04:00
doc(global): build cross-language links for translated documents 2018-04-27 02:46:13 -04:00			:link_to_translation:`zh_CN:[中文]`
Getting started guides 2017-03-26 18:01:52 -04:00
			`Install Prerequisites`
			`=====================`

docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be) 2019-06-24 21:29:49 -04:00			`ESP-IDF will use the version of Python installed by default on macOS.`

Getting started guides 2017-03-26 18:01:52 -04:00			`- install pip::`

			`sudo easy_install pip`

docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be) 2019-06-24 21:29:49 -04:00			`- install CMake & Ninja build:`
Getting started guides 2017-03-26 18:01:52 -04:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be) 2019-06-24 21:29:49 -04:00			`- If you have HomeBrew_, you can run::`
Getting started guides 2017-03-26 18:01:52 -04:00
Add build system support for programming ESP32-S2 using DFU utils 2020-04-06 10:41:44 -04:00			`brew install cmake ninja dfu-util`
Getting started guides 2017-03-26 18:01:52 -04:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be) 2019-06-24 21:29:49 -04:00			`- If you have MacPorts_, you can run::`
Getting started guides 2017-03-26 18:01:52 -04:00
Add build system support for programming ESP32-S2 using DFU utils 2020-04-06 10:41:44 -04:00			`sudo port install cmake ninja dfu-util`
Getting started guides 2017-03-26 18:01:52 -04:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be) 2019-06-24 21:29:49 -04:00			`- Otherwise, consult the CMake_ and Ninja_ home pages for macOS installation downloads.`
Getting started guides 2017-03-26 18:01:52 -04:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be) 2019-06-24 21:29:49 -04:00			- It is strongly recommended to also install ccache_ for faster builds. If you have HomeBrew_, this can be done via ``brew install ccache`` or ``sudo port install ccache`` on MacPorts_.
Getting started guides 2017-03-26 18:01:52 -04:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be) 2019-06-24 21:29:49 -04:00			`.. note::`
			`If an error like this is shown during any step::`
Getting started guides 2017-03-26 18:01:52 -04:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be) 2019-06-24 21:29:49 -04:00			`xcrun: error: invalid active developer path (/Library/Developer/CommandLineTools), missing xcrun at: /Library/Developer/CommandLineTools/usr/bin/xcrun`
Getting started guides 2017-03-26 18:01:52 -04:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be) 2019-06-24 21:29:49 -04:00			Then you will need to install the XCode command line tools to continue. You can install these by running ``xcode-select --install``.
Getting started guides 2017-03-26 18:01:52 -04:00
doc: Getting Started Guide, remove shortcuts to 'build toolchain from scratch' instructions 2020-09-03 14:05:24 -04:00			`Installing and setting up Python 3 as default`
			`---------------------------------------------`

			Basing on macOS `Catalina 10.15 release notes`_, use of Python 2.7 is not recommended and Python will not be included by default in future versions of macOS. Check what Python you currently have::

			`python --version`

			If the output is like ``Python 2.7.17``, your default interpreter is Python 2.7. If so, also check if Python 3 isn't already installed on your computer::

			`python3 --version`

			`If above command returns an error, it means Python 3 is not installed.`

			`Below is an overview of steps to install Python 3 and making it default interpreter.`

			`- Installing with HomeBrew_ can be done as follows::`

			`brew install python3`
			`ln -s /usr/local/bin/python3.8 /usr/local/bin/python`

			Adjust above directory name ``/usr/local/bin/python3.8`` to point where Python 3 has been installed. To check this directory you can run ``which -a python``.

			`- If you have MacPorts_, you can run::`

			`sudo port install python38`
			`sudo port select --set python python38`

			`Now open a new terminal session to verify what python is running by default::`

			`python --version`

			If the output is similar to ``Python 3.8.5``, your installation has been done successfully.


			`.. note::`

			`This is system-wide change which may affect all of the applications.`

Getting started guides 2017-03-26 18:01:52 -04:00			`Next Steps`
			`==========`

docs: Make CMake build system default, mark GNU Make as legacy option All `-cmake` suffixes are removed Where a GNU Make option is renamed, the `-legacy` suffix is used 2019-06-24 21:26:53 -04:00			To carry on with development environment setup, proceed to :ref:`get-started-get-esp-idf`.
Getting started guides 2017-03-26 18:01:52 -04:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be) 2019-06-24 21:29:49 -04:00
			`.. _cmake: https://cmake.org/`
			`.. _ninja: https://ninja-build.org/`
			`.. _ccache: https://ccache.samba.org/`
			`.. _homebrew: https://brew.sh/`
			`.. _MacPorts: https://www.macports.org/install.php`
doc: Getting Started Guide, remove shortcuts to 'build toolchain from scratch' instructions 2020-09-03 14:05:24 -04:00			`.. _Catalina 10.15 release notes: https://developer.apple.com/documentation/macos-release-notes/macos-catalina-10_15-release-notes`