espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-11-04 00:51:42 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
bdaf201bd04159bcc425a4b3c1b7e046d97ea479
esp-idf/docs/en/get-started/linux-setup.rst

65 lines
2.4 KiB
ReStructuredText
Raw Normal View History

docs: Make CMake build system default, mark GNU Make as legacy option All `-cmake` suffixes are removed Where a GNU Make option is renamed, the `-legacy` suffix is used
2019-06-25 11:26:53 +10:00
*********************************************
Standard Setup of Toolchain for Linux
*********************************************
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-25 11:29:49 +10:00
doc(global): build cross-language links for translated documents
2018-04-27 14:46:13 +08:00
:link_to_translation:`zh_CN:[中文]`
Getting started guides
2017-03-27 00:01:52 +02:00
Install Prerequisites
=====================
To compile with ESP-IDF you need to get the following packages:
- CentOS 7::
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-25 11:29:49 +10:00
sudo yum install git wget ncurses-devel flex bison gperf python pyserial python-pyelftools cmake ninja-build ccache
Getting started guides
2017-03-27 00:01:52 +02:00
- Ubuntu and Debian::
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-25 11:29:49 +10:00
sudo apt-get install git wget libncurses-dev flex bison gperf python python-pip python-setuptools python-serial python-click python-cryptography python-future python-pyparsing python-pyelftools cmake ninja-build ccache
Getting started guides
2017-03-27 00:01:52 +02:00
- Arch::
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-25 11:29:49 +10:00
sudo pacman -S --needed gcc git make ncurses flex bison gperf python2-pip python2-pyserial python2-click python2-cryptography python2-future python2-pyparsing python2-pyelftools cmake ninja ccache
Getting started guides
2017-03-27 00:01:52 +02:00
Add python-future by using python requirements file
2018-08-15 09:52:07 +02:00
.. note::
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-25 11:29:49 +10:00
CMake version 3.5 or newer is required for use with ESP-IDF. Older Linux distributions may require updating, enabling of a "backports" repository, or installing of a "cmake3" package rather than "cmake".
Add python-future by using python requirements file
2018-08-15 09:52:07 +02:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-25 11:29:49 +10:00
Additional Tips
Getting started guides
2017-03-27 00:01:52 +02:00
===============
docs: Improved documentation for /dev/ttyUSB0 issues Improved documentation for /dev/ttyUSB0 issues. This occurred in Ubuntu, but I'm sure is applies to most distributions. Merges https://github.com/espressif/esp-idf/pull/1158
2017-10-25 17:44:08 +13:00
Permission issues /dev/ttyUSB0
------------------------------
docs: Make CMake build system default, mark GNU Make as legacy option All `-cmake` suffixes are removed Where a GNU Make option is renamed, the `-legacy` suffix is used
2019-06-25 11:26:53 +10:00
With some Linux distributions you may get the ``Failed to open port /dev/ttyUSB0`` error message when flashing the ESP32. :ref:`This can be solved by adding the current user to the dialout group<linux-dialout-group>`.
docs: Improved documentation for /dev/ttyUSB0 issues Improved documentation for /dev/ttyUSB0 issues. This occurred in Ubuntu, but I'm sure is applies to most distributions. Merges https://github.com/espressif/esp-idf/pull/1158
2017-10-25 17:44:08 +13:00
docs: Explain ncurses5 for other distributions as well Ran into ncurses5 dependency issue on popOS stub section for covering libncurses 5 workarounds on distributions that need it, when only Arch was mentioned it was too easy to skip over the section Merges https://github.com/espressif/esp-idf/pull/3236
2019-03-31 05:45:20 +07:00
ncurses 5 dependency
--------------------
docs: Improved documentation for /dev/ttyUSB0 issues Improved documentation for /dev/ttyUSB0 issues. This occurred in Ubuntu, but I'm sure is applies to most distributions. Merges https://github.com/espressif/esp-idf/pull/1158
2017-10-25 17:44:08 +13:00
docs: Explain ncurses5 for other distributions as well Ran into ncurses5 dependency issue on popOS stub section for covering libncurses 5 workarounds on distributions that need it, when only Arch was mentioned it was too easy to skip over the section Merges https://github.com/espressif/esp-idf/pull/3236
2019-03-31 05:45:20 +07:00
To run the precompiled gdb (xtensa-esp32-elf-gdb) in Linux requires ncurses 5, but some newer distributions only provide ncurses 6 by default.
Getting started guides
2017-03-27 00:01:52 +02:00
docs: Explain ncurses5 for other distributions as well Ran into ncurses5 dependency issue on popOS stub section for covering libncurses 5 workarounds on distributions that need it, when only Arch was mentioned it was too easy to skip over the section Merges https://github.com/espressif/esp-idf/pull/3236
2019-03-31 05:45:20 +07:00
Consult your distribution's documentation to see if ncurses 5 libraries are available. Alternatively, use crosstool-NG to compile a gdb that links against ncurses 6.
Getting started guides
2017-03-27 00:01:52 +02:00
docs: Explain ncurses5 for other distributions as well Ran into ncurses5 dependency issue on popOS stub section for covering libncurses 5 workarounds on distributions that need it, when only Arch was mentioned it was too easy to skip over the section Merges https://github.com/espressif/esp-idf/pull/3236
2019-03-31 05:45:20 +07:00
For Arch Linux users, ncurses 5 libraries are available in AUR_ for native and lib32 configurations:
Getting started guides
2017-03-27 00:01:52 +02:00
- https://aur.archlinux.org/packages/ncurses5-compat-libs/
- https://aur.archlinux.org/packages/lib32-ncurses5-compat-libs/
linux docs: (Arch) Add key to keyring for me it was necessary to add the key manually to the key ring. Otherwise I could not have installed the packages Merges https://github.com/espressif/esp-idf/pull/1029 (Amended to remove reference to exact key, references AUR links instead.)
2017-09-22 17:38:08 -04:00
Before installing these packages you might need to add the author's public key to your keyring as described in the "Comments" section at the links above.
Getting started guides
2017-03-27 00:01:52 +02:00
Next Steps
==========
docs: Make CMake build system default, mark GNU Make as legacy option All `-cmake` suffixes are removed Where a GNU Make option is renamed, the `-legacy` suffix is used
2019-06-25 11:26:53 +10:00
To carry on with development environment setup, proceed to :ref:`get-started-get-esp-idf`.
Getting started guides
2017-03-27 00:01:52 +02:00
Related Documents
=================
.. toctree::
:maxdepth: 1
linux-setup-scratch
.. _AUR: https://wiki.archlinux.org/index.php/Arch_User_Repository
Reference in New Issue Copy Permalink