esp-idf/docs/en/get-started/linux-setup-scratch.rst

******************************************
Setup Linux Toolchain from Scratch
******************************************

:link_to_translation:`zh_CN:[中文]`

The following instructions are alternative to downloading binary toolchain from Espressif website. To quickly setup the binary toolchain, instead of compiling it yourself, backup and proceed to section :doc:`linux-setup`.

Install Prerequisites
=====================

To compile with ESP-IDF you need to get the following packages:

- CentOS 7::

    sudo yum install git wget ncurses-devel flex bison gperf python pyserial python-pyelftools cmake ninja-build ccache

- Ubuntu and Debian::

    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 libffi-dev libssl-dev

- Arch::

    sudo pacman -S --needed gcc git make ncurses flex bison gperf python2-pyserial python2-click python2-cryptography python2-future python2-pyparsing python2-pyelftools cmake ninja ccache

.. note::
    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".

Compile the Toolchain from Source
=================================

- Install dependencies:

  - CentOS 7::

        sudo yum install gawk gperf grep gettext ncurses-devel python python-devel automake bison flex texinfo help2man libtool make

  - Ubuntu pre-16.04::

        sudo apt-get install gawk gperf grep gettext libncurses-dev python python-dev automake bison flex texinfo help2man libtool make

  - Ubuntu 16.04 or newer::

        sudo apt-get install gawk gperf grep gettext python python-dev automake bison flex texinfo help2man libtool libtool-bin make

  - Debian 9::

        sudo apt-get install gawk gperf grep gettext libncurses-dev python python-dev automake bison flex texinfo help2man libtool libtool-bin make

  - Arch::

        TODO

Create the working directory and go into it::

  mkdir -p ~/esp
  cd ~/esp

Download ``crosstool-NG`` and build it:

.. include:: /_build/inc/scratch-build-code.inc

Build the toolchain::

    ./ct-ng xtensa-esp32-elf
    ./ct-ng build
    chmod -R u+w builds/xtensa-esp32-elf

Toolchain will be built in ``~/esp/crosstool-NG/builds/xtensa-esp32-elf``. Follow :ref:`instructions for standard setup <setup-linux-toolchain-add-it-to-path-legacy>` to add the toolchain to your ``PATH``.


Next Steps
==========

To carry on with development environment setup, proceed to :ref:`get-started-get-esp-idf`.
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			`******************************************`
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			`Setup Linux Toolchain from Scratch`
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			`******************************************`

Included missing links between English and Chinese documentation, where translation into Chinese is available 2019-01-27 19:01:34 +01:00			:link_to_translation:`zh_CN:[中文]`
Getting started guides 2017-03-27 00:01:52 +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			The following instructions are alternative to downloading binary toolchain from Espressif website. To quickly setup the binary toolchain, instead of compiling it yourself, backup and proceed to section :doc:`linux-setup`.
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:`

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			`- CentOS 7::`

			`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: Update Debian & Ubuntu install prerequisites Latest versions of apt-get don't install as much packages by default as older ones. This fix adds some missing packages discovered for an OS derived from the latest stable Debian. These packages exist for older Debian derivatives as well (tested with Ubuntu 16.04 LTS). Closes https://github.com/espressif/esp-idf/issues/4480 2019-12-16 11:41:28 +01: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 libffi-dev libssl-dev`
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-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".`
Getting started guides 2017-03-27 00:01:52 +02:00
			`Compile the Toolchain from Source`
			`=================================`

			`- Install dependencies:`

			`- 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 gawk gperf grep gettext ncurses-devel python python-devel automake bison flex texinfo help2man libtool make`
Getting started guides 2017-03-27 00:01:52 +02:00
			`- Ubuntu pre-16.04::`

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 gawk gperf grep gettext libncurses-dev python python-dev automake bison flex texinfo help2man libtool make`
Getting started guides 2017-03-27 00:01:52 +02:00
docs: Update package dependencies Closes https://github.com/espressif/esp-idf/issues/2384 2019-03-01 10:50:16 +01:00			`- Ubuntu 16.04 or newer::`
Getting started guides 2017-03-27 00:01:52 +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			`sudo apt-get install gawk gperf grep gettext python python-dev automake bison flex texinfo help2man libtool libtool-bin make`
Getting started guides 2017-03-27 00:01:52 +02:00
Add build dependencies for toolchain for Debian Merges https://github.com/espressif/esp-idf/pull/1465 2018-01-05 10:48:35 +01:00			`- Debian 9::`
Getting started guides 2017-03-27 00:01:52 +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			`sudo apt-get install gawk gperf grep gettext libncurses-dev python python-dev automake bison flex texinfo help2man libtool libtool-bin make`
Getting started guides 2017-03-27 00:01:52 +02:00
			`- Arch::`

			`TODO`

docs: fix instructions for building toolchain on macOS Closes https://github.com/espressif/esp-idf/issues/503 Closes https://github.com/espressif/esp-idf/issues/2607 2018-10-22 13:45:09 +08:00			`Create the working directory and go into it::`

			`mkdir -p ~/esp`
			`cd ~/esp`

docs: generate toolchain download links 2018-08-29 21:30:03 +08:00			Download ``crosstool-NG`` and build it:
Getting started guides 2017-03-27 00:01:52 +02:00
docs: generate toolchain download links 2018-08-29 21:30:03 +08:00			`.. include:: /_build/inc/scratch-build-code.inc`
Getting started guides 2017-03-27 00:01:52 +02:00
			`Build the toolchain::`

			`./ct-ng xtensa-esp32-elf`
			`./ct-ng build`
			`chmod -R u+w builds/xtensa-esp32-elf`

Fix broken links in 'Getting Started' gudes 2019-08-02 17:09:33 +08:00			Toolchain will be built in ``~/esp/crosstool-NG/builds/xtensa-esp32-elf``. Follow :ref:`instructions for standard setup <setup-linux-toolchain-add-it-to-path-legacy>` to add the toolchain to your ``PATH``.
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`.