From 33be627a1b79638cbca1bbda1bba131f9d55c721 Mon Sep 17 00:00:00 2001 From: Sergio Gasquez Date: Thu, 27 Oct 2022 13:57:47 +0000 Subject: [PATCH] =?UTF-8?q?docs:=20=F0=9F=93=9D=20Add=20details=20about=20?= =?UTF-8?q?requirements?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 0c3b645..c551015 100644 --- a/README.md +++ b/README.md @@ -15,30 +15,35 @@ developing applications in Rust for Espressif SoC's. > This application is still under development and should be considered experimental ## Requirements -Before running or installing `espup`, make sure that [`rustup`](https://www.rust-lang.org/tools/install) -and the following dependencies are installed. +Before running or installing `espup`, make sure that [`rustup`](https://www.rust-lang.org/tools/install) and the following dependencies are installed. ### Windows -- [Python](https://www.python.org/downloads/). Version should be between `3.6` and `3.10`. -- [git](https://git-scm.com/download/win) -- Toolchain. Select one of the following: - - [Windows x86_64 GNU](https://github.com/esp-rs/rust-build#windows-x86_64-gnu) - - [Windows x86_64 MSVC](https://github.com/esp-rs/rust-build#windows-x86_64-msvc) - +- [git](https://git-scm.com/download/win). +- [Python](https://www.python.org/downloads/): Only required when installing ESP-IDF. ### Linux - Ubuntu/Debian ```sh sudo apt-get install -y git python3 python3-pip gcc build-essential curl pkg-config libudev-dev libtinfo5 ``` + - `libudev-dev` is only required when installing `cargo-espflash`. + - `python3` and `python3-pip` are only required when installing ESP-IDF. + - `libtinfo5` is required by LLVM 15. - Fedora ```sh sudo dnf -y install git python3 python3-pip gcc systemd-devel ncurses-compat-libs ``` + - `systemd-devel` is only required when installing `cargo-espflash`. + - `python3` and `python3-pip` are only required when installing ESP-IDF. + - `ncurses-compat-libs` is required by LLVM 15. - openSUSE Thumbleweed/Leap ``` sudo zypper install -y git gcc libudev-devel ninja python3 python3-pip make libncurses5 ``` + - `libudev-devel` is only required when installing `cargo-espflash`. + - `python3` and `python3-pip` are only required when installing ESP-IDF. + - `libncurses5` is required by LLVM 15. + ## Installation