macos-setup.rst 1.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. **********************************************
  2. Standard Setup of Toolchain for Mac OS
  3. **********************************************
  4. :link_to_translation:`zh_CN:[中文]`
  5. Install Prerequisites
  6. =====================
  7. ESP-IDF will use the version of Python installed by default on macOS.
  8. - install pip::
  9. sudo easy_install pip
  10. - install pyserial::
  11. pip install --user pyserial
  12. - install CMake & Ninja build:
  13. - If you have HomeBrew_, you can run::
  14. brew install cmake ninja dfu-util
  15. - If you have MacPorts_, you can run::
  16. sudo port install cmake ninja dfu-util
  17. - Otherwise, consult the CMake_ and Ninja_ home pages for macOS installation downloads.
  18. - 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_.
  19. .. note::
  20. If an error like this is shown during any step::
  21. xcrun: error: invalid active developer path (/Library/Developer/CommandLineTools), missing xcrun at: /Library/Developer/CommandLineTools/usr/bin/xcrun
  22. Then you will need to install the XCode command line tools to continue. You can install these by running ``xcode-select --install``.
  23. Next Steps
  24. ==========
  25. To carry on with development environment setup, proceed to :ref:`get-started-get-esp-idf`.
  26. Related Documents
  27. =================
  28. .. toctree::
  29. :maxdepth: 1
  30. macos-setup-scratch
  31. .. _cmake: https://cmake.org/
  32. .. _ninja: https://ninja-build.org/
  33. .. _ccache: https://ccache.samba.org/
  34. .. _homebrew: https://brew.sh/
  35. .. _MacPorts: https://www.macports.org/install.php