docs: Copy CMake docs to a separate set of directories

Required first step before merging back to mainline.
This commit is contained in:
Angus Gratton
2018-08-08 17:58:00 +10:00
committed by Angus Gratton
parent dbb82a413f
commit 191557db02
65 changed files with 4364 additions and 1122 deletions

View File

@@ -3,9 +3,6 @@ Standard Setup of Toolchain for Linux
*************************************
:link_to_translation:`zh_CN:[中文]`
.. note::
This is documentation for the CMake-based build system which is currently in preview release. The documentation may have gaps, and you may encounter bugs (please report either of these). To view documentation for the older GNU Make based build system, switch versions to the 'latest' master branch or a stable release.
Install Prerequisites
=====================
@@ -13,18 +10,16 @@ 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 cmake ninja-build ccache
sudo yum install gcc git wget make ncurses-devel flex bison gperf python pyserial
- Ubuntu and Debian::
sudo apt-get install git wget libncurses-dev flex bison gperf python python-serial cmake ninja-build ccache
sudo apt-get install gcc git wget make libncurses-dev flex bison gperf python python-serial
- Arch::
sudo pacman -S --needed gcc git make ncurses flex bison gperf python2-pyserial cmake ninja ccache
sudo pacman -S --needed gcc git make ncurses flex bison gperf python2-pyserial
.. note::
CMake version 3.5 or newer is required for use with ESP-IDF. Older Linux distributions may require updating, or enabling of a "backports" repository, or installing of a "cmake3" package not "cmake")
Toolchain Setup
===============
@@ -84,7 +79,7 @@ With some Linux distributions you may get the ``Failed to open port /dev/ttyUSB0
Arch Linux Users
----------------
To run the precompiled gdb (xtensa-esp32-elf-gdb) in Arch Linux requires ncurses 5, but Arch uses ncurses 6.
To run the precompiled gdb (xtensa-esp32-elf-gdb) in Arch Linux requires ncurses 5, but Arch uses ncurses 6.
Backwards compatibility libraries are available in AUR_ for native and lib32 configurations: