OVMS3-idf/docs/en/get-started-cmake/macos-setup.rst

***********************************************
Installation of Prerequisites for macOS (CMake)
***********************************************

:link_to_translation:`zh_CN:[中文]`

.. include:: ../cmake-warning.rst

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

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

- install pip::

    sudo easy_install pip

- install pyserial::

    pip install --user pyserial

- install CMake & Ninja build:

  - If you have HomeBrew_, you can run::

      brew install cmake ninja

  - If you have MacPorts_, you can run::

      sudo port install cmake ninja

  - 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``.

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

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

Related Documents
=================

.. toctree::
    :maxdepth: 1

    macos-setup-scratch

.. _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
docs: update CMake getting started guide to use install.bat and export.bat 2019-03-27 05:29:06 +00:00			`***********************************************`
			`Installation of Prerequisites for macOS (CMake)`
			`***********************************************`
docs: Copy CMake docs to a separate set of directories Required first step before merging back to mainline. 2018-08-08 07:58:00 +00:00
1.Update 8 English cmake files 2.Provide Chinese translation to these 8 cmake files 2018-11-06 04:02:21 +00:00			:link_to_translation:`zh_CN:[中文]`

docs: Copy CMake docs to a separate set of directories Required first step before merging back to mainline. 2018-08-08 07:58:00 +00:00			`.. include:: ../cmake-warning.rst`

			`Install Prerequisites`
			`=====================`

docs: update CMake getting started guide to use install.bat and export.bat 2019-03-27 05:29:06 +00:00			`ESP-IDF will use the version of Python installed by default on macOS.`
docs: Copy CMake docs to a separate set of directories Required first step before merging back to mainline. 2018-08-08 07:58:00 +00:00
			`- install pip::`

			`sudo easy_install pip`

			`- install pyserial::`

Encourage to install python packages without administrative rights Using 'sudo pip install' can cause a lot of problems because usually there are a couple of Python interpreters installed. This fix encourages developers to use `pip install --user` instead which is safer. 2018-09-07 07:14:05 +00:00			`pip install --user pyserial`
docs: Copy CMake docs to a separate set of directories Required first step before merging back to mainline. 2018-08-08 07:58:00 +00:00
			`- install CMake & Ninja build:`

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

			`brew install cmake ninja`

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

			`sudo port install cmake ninja`

docs: update CMake getting started guide to use install.bat and export.bat 2019-03-27 05:29:06 +00:00			`- Otherwise, consult the CMake_ and Ninja_ home pages for macOS installation downloads.`
docs: Copy CMake docs to a separate set of directories Required first step before merging back to mainline. 2018-08-08 07:58:00 +00: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_.

			`.. 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`

docs: update CMake getting started guide to use install.bat and export.bat 2019-03-27 05:29:06 +00:00			Then you will need to install the XCode command line tools to continue. You can install these by running ``xcode-select --install``.
docs: Copy CMake docs to a separate set of directories Required first step before merging back to mainline. 2018-08-08 07:58:00 +00:00
			`Next Steps`
			`==========`

Introduced installation steps to improve navigation through the installation process. Included some updates from GNU make section. 2019-02-04 20:51:50 +00:00			To carry on with development environment setup, proceed to :ref:`get-started-get-esp-idf-cmake`.
docs: Copy CMake docs to a separate set of directories Required first step before merging back to mainline. 2018-08-08 07:58:00 +00:00
			`Related Documents`
			`=================`

			`.. toctree::`
			`:maxdepth: 1`

			`macos-setup-scratch`

			`.. _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`