From 28a862681e52952f7fd64049bffda9bc8aa1ff19 Mon Sep 17 00:00:00 2001 From: Jannik Beyerstedt Date: Sat, 23 May 2020 22:44:19 +0200 Subject: [PATCH] [DOC] small improvements in the Readme --- README.md | 21 ++++++++------------- 1 file changed, 8 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 8f65124..b8e843a 100644 --- a/README.md +++ b/README.md @@ -13,9 +13,12 @@ This repository contains the code running on the ESP32, as well as the PCB and c ## Dependencies +The [esp32-idf](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/index.html#installation-step-by-step) is needed to compile software for the ESP32. +The following sections will install to `~/Development/esp32` as an example. + Prepare toolchain (macOS): ``` -cd ~/JBeyerstedt-Projekte/ +cd ~/Development/ mkdir ./esp32 cd esp32 curl https://dl.espressif.com/dl/xtensa-esp32-elf-osx-1.22.0-80-g6c4433a-5.2.0.tar.gz -o xtensa-esp32-elf-osx-1.22.0-80-g6c4433a-5.2.0.tar.gz @@ -37,17 +40,13 @@ rm xtensa-esp32-elf-linux64-1.22.0-73-ge28a011-5.2.0.tar.gz Add to your bash profile, zshrc or other: ``` -export PATH=$PATH:$HOME/JBeyerstedt-Projekte/esp32/xtensa-esp32-elf/bin -export IDF_PATH = $HOME/JBeyerstedt-Projekte/esp32/esp-idf -``` -or for ubuntu devel vm: -``` export PATH=$PATH:$HOME/Development/esp32/xtensa-esp32-elf/bin export IDF_PATH = $HOME/Development/esp32/esp-idf ``` Install esp-idf: ``` +cd ~/Development/esp32 git clone --recursive https://github.com/espressif/esp-idf.git ``` @@ -55,13 +54,9 @@ git clone --recursive https://github.com/espressif/esp-idf.git ## Checkout this project and configure arduino-esp32 with esp-idf: ``` -TODO!! - -mkdir -p components && \ -cd components && \ -git clone https://github.com/espressif/arduino-esp32.git arduino && \ -cd arduino && \ -git submodule update --init --recursive && \ +mkdir -p components && cd components +git clone https://github.com/espressif/arduino-esp32.git arduino && cd arduino +git submodule update --init --recursive cd ../.. ```