Crash_Override/OVMS3-idf
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
OVMS3-idf/docs/en/get-started/linux-setup.rst

51 lines
1.6 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 01:26:53 +00: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 01:29:49 +00:00
doc(global): build cross-language links for translated documents
2018-04-27 06:46:13 +00:00
:link_to_translation:`zh_CN:[中文]`
Getting started guides
2017-03-26 22:01:52 +00:00
Install Prerequisites
=====================
To compile with ESP-IDF you need to get the following packages:
- CentOS 7::
Update kconfiglib to upstream version and replace mconf-idf Special thanks to @ulfalizer for the helpful suggestions regarding kconfiglib. "rsource" option is available for relative path includes Closes https://github.com/espressif/esp-idf/issues/4064
2019-09-10 07:58:52 +00:00
sudo yum install git wget flex bison gperf python pyserial python-pyelftools cmake ninja-build ccache
Getting started guides
2017-03-26 22:01:52 +00: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 10:41:28 +00:00
sudo apt-get install git wget 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-26 22:01:52 +00:00
- Arch::
Update kconfiglib to upstream version and replace mconf-idf Special thanks to @ulfalizer for the helpful suggestions regarding kconfiglib. "rsource" option is available for relative path includes Closes https://github.com/espressif/esp-idf/issues/4064
2019-09-10 07:58:52 +00:00
sudo pacman -S --needed gcc git make 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-26 22:01:52 +00:00
Add python-future by using python requirements file
2018-08-15 07:52:07 +00: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 01:29:49 +00: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 07:52:07 +00: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 01:29:49 +00:00
Additional Tips
Getting started guides
2017-03-26 22:01:52 +00: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 04:44:08 +00: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 01:26:53 +00: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 04:44:08 +00:00
Getting started guides
2017-03-26 22:01:52 +00: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 01:26:53 +00:00
To carry on with development environment setup, proceed to :ref:`get-started-get-esp-idf`.
Getting started guides
2017-03-26 22:01:52 +00:00
Related Documents
=================
.. toctree::
:maxdepth: 1
docs: Mark some more docs sections as ESP32 only
2019-11-26 06:22:50 +00:00
:esp32: linux-setup-scratch
Getting started guides
2017-03-26 22:01:52 +00:00
.. _AUR: https://wiki.archlinux.org/index.php/Arch_User_Repository
Reference in a new issue Copy permalink