From 98453467e04503e524337f03c47e39760245a570 Mon Sep 17 00:00:00 2001 From: Johnathon Slightham Date: Wed, 14 May 2025 13:46:17 -0400 Subject: [PATCH] Update README.md --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 8c3c2d1..3f7dab8 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ **This project is currently setup to work with the ESP32, we will be using the ESP32-c6 in the future.** -## Install Dependencies -### MacOS +### Install Dependencies +#### MacOS Install xcode command line tools (if you do not already have them) ``` xcode-select --install @@ -24,10 +24,11 @@ cd ~/esp/isp-idf ./install.sh esp32 ``` -## Running +## Development +### Command Line Tools The board is flashed via UART. A USB to UART adapter is provided as part of the devboard. -### MacOS +#### MacOS Export environment variables ``` . ~/esp/esp-idf/export.sh @@ -43,9 +44,9 @@ Flash and open serial monitor idf.py flash monitor ``` -## Using an IDE +### Using an IDE Any IDE that supports CMake should be compatible with this project. -### JetBrains CLion +#### JetBrains CLion CLion is compatible with this project. Follow [the tutorial on Espressif's site](https://developer.espressif.com/blog/clion/) with the following modifications: - When asked to select a project, simply import the root directory of this repository (ie. the `firmware` folder). - If the `Open Project Wizard` does not open, access it via `Settings > Build, Execution, Deployment > CMake`.