Skip to content

Commit

Permalink
doc: gsg: macOS: Include instructions to add homebrew to the path
Browse files Browse the repository at this point in the history
Multiple users have failed to read the output from the Homebrew
installation script, which instructs the user how to add it to the
path. Include the instructions in the guide.

Also add a step to include the Homebrew Python executable to the path,
which allows then for invocation of python and pip as well as python3
and pip3.

Signed-off-by: Carles Cufi <[email protected]>
  • Loading branch information
carlescufi authored and fabiobaltieri committed Nov 10, 2023
1 parent 5bd1888 commit 318836a
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions doc/develop/getting_started/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -116,12 +116,32 @@ The current minimum required version for the main dependencies are:
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
#. After the Homebrew installation script completes, follow the on-screen
instructions to add the Homebrew installation to the path.

* On macOS running on Apple Silicon, this is achieved with:

.. code-block:: bash
(echo; echo 'eval "$(/opt/homebrew/bin/brew shellenv)"') >> ~/.zprofile
source ~/.zprofile
* On macOS running on Intel, use the command for Apple Silicon, but replace ``/opt/homebrew/`` with ``/usr/local/``.

#. Use ``brew`` to install the required dependencies:

.. code-block:: bash
brew install cmake ninja gperf python3 ccache qemu dtc wget libmagic
#. Add the Homebrew Python folder to the path, in order to be able to
execute ``python`` and ``pip`` as well ``python3`` and ``pip3``.

.. code-block:: bash
(echo; echo 'export PATH="'$(brew --prefix)'/opt/python/libexec/bin:$PATH"') >> ~/.zprofile
source ~/.zprofile
.. group-tab:: Windows

.. note::
Expand Down

0 comments on commit 318836a

Please sign in to comment.