jannik/esp32-sensornode
1
1
Fork 0
Code Issues Pull requests Releases Wiki Activity

[DOC] small improvements in the Readme

Browse source
This commit is contained in:
Jannik Beyerstedt 2020-05-23 22:44:19 +02:00
parent 30402d41d3
commit 28a862681e
1 changed files with 8 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -13,9 +13,12 @@ This repository contains the code running on the ESP32, as well as the PCB and c
## Dependencies ## 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): Prepare toolchain (macOS):
``` ```
cd ~/JBeyerstedt-Projekte/ cd ~/Development/
mkdir ./esp32 mkdir ./esp32
cd 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 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: 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 PATH=$PATH:$HOME/Development/esp32/xtensa-esp32-elf/bin
export IDF_PATH = $HOME/Development/esp32/esp-idf export IDF_PATH = $HOME/Development/esp32/esp-idf
``` ```
Install esp-idf: Install esp-idf:
``` ```
cd ~/Development/esp32
git clone --recursive https://github.com/espressif/esp-idf.git 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: ## 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
mkdir -p components && \ git submodule update --init --recursive
cd components && \
git clone https://github.com/espressif/arduino-esp32.git arduino && \
cd arduino && \
git submodule update --init --recursive && \
cd ../.. cd ../..
``` ```