Templates/ESP32_Project/README.md

35 lines
1018 B
Markdown

# ESP32_Project
## Description
This is a template for **C** project for esp32 boards using PlatformIO with the esp-idf framework, better than Arduino but proprietary.
## Setup
To make this template work you will need to install PlatformIO.
For this use this link : [super quick install](https://docs.platformio.org/en/latest/core/installation/methods/installer-script.html#super-quick-macos-linux)
During installation select all boards.
Then in the project's platformio.ini change the board id to the one that you can find by using :
```bash
pio boards your_board
```
And finally in the project dir run :
```bash
pio project init
```
## Usage
In vscode open your task runner and use the different tasks :
- **Build** : Build the current project
- **Build and Upload** : Build project and upload to device
- **Clean** : Clean build directory
They correspond to calling make with the following :
- **Build** : pio run
- **Build and Upload** : pio run --target upload
- **Clean** : pio run --target clean