Skip to content

Commit

Permalink
update mac install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
alex-dewar committed Aug 15, 2023
1 parent dbc3e49 commit cf5e3eb
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 5 deletions.
2 changes: 2 additions & 0 deletions docs/linux-install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,8 @@ but we'll grab 3.9.5 here and make an env called cw:
pyenv virtualenv 3.9.5 cw
pyenv activate cw
.. _linux-install-chipwhisperer:

========================
Installing ChipWhisperer
========================
Expand Down
20 changes: 15 additions & 5 deletions docs/mac-install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,20 +54,22 @@ and make sure it reports that you're using Python 3.9.5.
Compilers
=========

The compilers are also available on Mac OSx. The ARM compiler can be found
on the `ARM website`_. If needed, the AVR compiler can be installed as well
using:
The compilers are also available on Mac OSx. You can install by running:

.. code:: bash
# install arm-gcc
brew install --cask gcc-arm-embedded
# install avr-gcc
brew tap osx-cross/avr
brew install avr-gcc
This brew install does not work for some older versions of Mac OS X. You will
have to find a different way to install the compilers.

.. _Python Software Foundation's website: https://www.python.org/downloads/mac-osx/
.. _ARM website: https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm/downloads

Mac M1 Notes
============
Expand All @@ -76,4 +78,12 @@ ChipWhisperer is compatable with Mac M1; however, due to the M1's different arch
as well as its x86 emulation, you need to manually install libusb1 and ensure that the
architecture for libusb1 matches the architecture for Python.

See https://github.com/newaetech/chipwhisperer/issues/381 for more information.
The best way to do this seems to be to install Python via conda miniforge and to use the newest
homebrew to install libusb.

See https://github.com/newaetech/chipwhisperer/issues/381 for more information.

Installing ChipWhisperer
========================

See the :ref:`Linux install instructions. <linux-install-chipwhisperer>`

0 comments on commit cf5e3eb

Please sign in to comment.