mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-08-14 12:15:22 +00:00
0d811b9aee
The getting started documentation has become a bit of a mess over time: - The reader needs to jump forward and backward in the documents depending on what their system already has installed (e.g. "start by cloning Zephyr, oh wait, see below if you don't have Git yet" etc.). - The operating system setup guides, toolchain setup instructions, and application build and run information have each become their own balkanized fiefdom, with duplicated, confusing and sometimes inconsistent results. - Linux documentation for all distributions is incomplete in some places (the Arch documentation in particular is vestigial) and wrong in others (platforms like Ubuntu still nominally require tools, like autoconf, that haven't been necessary since we stopped using the C Kconfig tools) - The dependencies needed to build the documentation have gotten *huge* since the LaTeX additions and massively overstate the footprint of Zephyr's real dependencies. This is particularly a problem on Linux, where those dependencies were not clearly separated from those needed to build Zephyr. - The toolchain setup documentation is confusing and scattered across the main file and the platform-specific files. There are various bits of incomplete and/or incorrect information. For example, the docs imply that you can use the Zephyr SDK on non-Linux hosts, which isn't true. As another example, some toolchains, such as GNU Arm Embedded, are documented several times. As a final example, some toolchains, such as Intel's ISSM, are squirrelled away in the Windows document when there are Linux builds available. Overhaul the pages to fix these issues and otherwise clean up the language. One significant side-effect is that all the toolchain-related information is rooted in a single toctree. Another is that it should now be possible to follow the instructions, in order, on any supported platform. Signed-off-by: Marti Bolivar <marti@foundries.io>
57 lines
2.0 KiB
ReStructuredText
57 lines
2.0 KiB
ReStructuredText
.. _installing_zephyr_mac:
|
|
|
|
Development Environment Setup on macOS
|
|
######################################
|
|
|
|
.. important::
|
|
|
|
This section only describes OS-specific setup instructions; it is the first step in the
|
|
complete Zephyr :ref:`getting_started`.
|
|
|
|
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.)
|
|
|
|
.. note::
|
|
|
|
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.
|
|
|
|
After Homebrew is successfully installed, install the following tools using
|
|
the ``brew`` command line tool in the Terminal application.
|
|
|
|
.. code-block:: console
|
|
|
|
brew install cmake ninja gperf ccache dfu-util qemu dtc python3
|
|
|
|
.. _Homebrew site: https://brew.sh/
|