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

******************************************
Setup Linux Toolchain from Scratch (CMake)
******************************************

:link_to_translation:`zh_CN:[中文]`

.. include:: ../cmake-warning.rst

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

- 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 `instructions for standard setup <setup-linux-toolchain-add-it-to-path-cmake>`_ to add the toolchain to your ``PATH``.


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

To carry on with development environment setup, proceed to :ref:`get-started-get-esp-idf-cmake`.
docs: Copy CMake docs to a separate set of directories Required first step before merging back to mainline. 2018-08-08 07:58:00 +00:00			`******************************************`
			`Setup Linux Toolchain from Scratch (CMake)`
			`******************************************`

Doc/translation linux setup scratch wangfang 2018-11-19 04:14:45 +00:00			:link_to_translation:`zh_CN:[中文]`

docs: Copy CMake docs to a separate set of directories Required first step before merging back to mainline. 2018-08-08 07:58:00 +00:00			`.. include:: ../cmake-warning.rst`

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

sys_view: Adds processing scripts for heap & log traces 2018-12-12 17:38:23 +00:00			`sudo yum install git wget ncurses-devel flex bison gperf python pyserial python-pyelftools cmake ninja-build ccache`
docs: Copy CMake docs to a separate set of directories Required first step before merging back to mainline. 2018-08-08 07:58:00 +00:00
			`- Ubuntu and Debian::`

Add click package to linux setup instructions 2019-06-11 12:30:01 +00: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`
docs: Copy CMake docs to a separate set of directories Required first step before merging back to mainline. 2018-08-08 07:58:00 +00:00
			`- Arch::`

Add click package to linux setup instructions 2019-06-11 12:30:01 +00: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`
docs: Copy CMake docs to a separate set of directories Required first step before merging back to mainline. 2018-08-08 07:58:00 +00:00
			`.. 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`

docs: Update package dependencies Closes https://github.com/espressif/esp-idf/issues/2384 2019-03-01 09:50:16 +00:00			`- Ubuntu 16.04 or newer::`
docs: Copy CMake docs to a separate set of directories Required first step before merging back to mainline. 2018-08-08 07:58:00 +00:00
			`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`

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 05:45:09 +00:00			`Create the working directory and go into it::`
docs: Copy CMake docs to a separate set of directories Required first step before merging back to mainline. 2018-08-08 07:58:00 +00:00
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 05:45:09 +00:00			`mkdir -p ~/esp`
			`cd ~/esp`

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

			`.. include:: /_build/inc/scratch-build-code.inc`
docs: Copy CMake docs to a separate set of directories Required first step before merging back to mainline. 2018-08-08 07:58:00 +00:00
			`Build the toolchain::`

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

1.Update 8 English cmake files 2.Provide Chinese translation to these 8 cmake files 2018-11-06 04:02:21 +00:00			Toolchain will be built in ``~/esp/crosstool-NG/builds/xtensa-esp32-elf``. Follow `instructions for standard setup <setup-linux-toolchain-add-it-to-path-cmake>`_ to add the toolchain to your ``PATH``.
docs: Copy CMake docs to a separate set of directories Required first step before merging back to mainline. 2018-08-08 07:58:00 +00:00

			`Next Steps`
			`==========`

Introduced installation steps to improve navigation through the installation process. Included some updates from GNU make section. 2019-02-04 20:51:50 +00:00			To carry on with development environment setup, proceed to :ref:`get-started-get-esp-idf-cmake`.