mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-08-27 09:55:22 +00:00
331214704c
As presented to the TSC, Zephyr's out-of-box experience for new developers is, well, complicated. A number of suggestions were presented including simplifying the getting started material to present a straight-forward path through the setup and installation steps through to getting a sample application built, flashed, and running. This PR is a work-in-progress towards addressing this OOB experience with a minimal-distractions version of the GSG. Alternatives, warnings, and material that could lead the developer astray were moved to alternative/advanced instruction documents (based on the previous separate Linux/macOS/Windows setup guides) and a new "Beyond the GSG" document. We do take advantage of a sphinx-tabs extension for synchronized tabs to present OS-specific instructions: clicking on one tab will display all same-named tabs throughout the doc. We hope (and will continue evaluating) that this new GSG gets developers set up quickly and then we can send them along to other documents to continue learning about Zephyr and trying other sample apps. Thanks for all your previous feedback that I've worked into this new version. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
55 lines
2.1 KiB
ReStructuredText
55 lines
2.1 KiB
ReStructuredText
.. _installing_zephyr_mac:
|
|
|
|
Install macOS Host Dependencies
|
|
###############################
|
|
|
|
This section describes how to set up a Zephyr development environment on macOS.
|
|
|
|
These instructions have been tested on the following macOS versions:
|
|
|
|
* Mac OS X 10.11 (El Capitan)
|
|
* macOS Sierra 10.12
|
|
|
|
Update Your Operating System
|
|
****************************
|
|
|
|
Before proceeding with the build, ensure your OS is up to date.
|
|
|
|
.. _mac_requirements:
|
|
|
|
Install Requirements and Dependencies
|
|
*************************************
|
|
|
|
.. NOTE FOR DOCS AUTHORS: DO NOT PUT DOCUMENTATION BUILD DEPENDENCIES HERE.
|
|
|
|
This section is for dependencies to build Zephyr binaries, *NOT* this
|
|
documentation. If you need to add a dependency only required for building
|
|
the docs, add it to doc/README.rst. (This change was made following the
|
|
introduction of LaTeX->PDF support for the docs, as the texlive footprint is
|
|
massive and not needed by users not building PDF documentation.)
|
|
|
|
Zephyr requires Python 3, while macOS only provides a Python 2
|
|
installation. After following these instructions, the version of Python 2
|
|
provided by macOS in ``/usr/bin/`` will sit alongside the Python 3 installation
|
|
from Homebrew in ``/usr/local/bin``.
|
|
|
|
First, install :program:`Homebrew` by following instructions on the `Homebrew
|
|
site`_. Homebrew is a free and open-source package management system that
|
|
simplifies the installation of software on macOS. While installing Homebrew,
|
|
you may be prompted to install additional missing dependencies; please follow
|
|
any such instructions as well.
|
|
|
|
Now install these host dependencies with the ``brew`` command:
|
|
|
|
.. code-block:: console
|
|
|
|
brew install cmake ninja gperf ccache dfu-util qemu dtc python3
|
|
|
|
.. _Homebrew site: https://brew.sh/
|
|
|
|
Additional notes for MacPorts users
|
|
***********************************
|
|
|
|
While MacPorts is not officially supported in this guide, it is possible to use MacPorts instead of Homebrew to get all the required dependencies on macOS.
|
|
Note also that you may need to install ``rust`` and ``cargo`` for the Python dependencies to install correctly.
|