From f960dba5a8468c047bda96c16d53e3ad6d008005 Mon Sep 17 00:00:00 2001
From: rkcf <rkcf@rkcf.me>
Date: Mon, 20 Feb 2023 08:18:05 -0600
Subject: [PATCH] Docs: add project setup section to README

---
 README.org | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)

diff --git a/README.org b/README.org
index f7315b8..9c93637 100644
--- a/README.org
+++ b/README.org
@@ -12,6 +12,36 @@ This project aims to create a generic esp32-s3 based eurorack modular unit—rep
   - 4 buttons
 - 2.2in TFT LCD Display
 
+* Project Setup
+Clone the repository over ssh.
+#+BEGIN_SRC shell
+git clone git@gitea.rkcf.me/rkcf/esp32_eurorack_generic.git
+cd esp32_eurorack_generic
+#+END_SRC
+
+Source idf path. Assumes [[https://docs.espressif.com/projects/esp-idf/en/v5.0/esp32s3/get-started/index.html#installation][ESP-IDF]] properly configured on system.
+#+BEGIN_SRC shell
+. $YOUR_PATH_TO_ESP_IDF/export.sh
+#+END_SRC
+
+Set the target chip and configure the project. NOTE: Running menuconfig is not currently necessary for this project.
+#+BEGIN_SRC shell
+idf.py set-target esp32s3
+idf.py menuconfig
+#+END_SRC
+
+Building and flashing the project. Where $PORT is the boards serial port system address (e.g. /dev/ttyUSB0).
+#+BEGIN_SRC shell
+idf.py build
+idf.py -p $PORT flash
+idf.py -p $PORT monitor
+#+END_SRC
+
+Or do all of this in one go with:
+#+BEGIN_SRC shell
+idf.py -p $PORT flash monitor
+#+END_SRC
+
 * Contributing
 - Currently this branch is bleeding edge for rapid prototyping. In the future, a design will be homolugated and [[https://semver.org/][Semantic Versioning 2.0.0]] will be used. Note that schematics have their own versioning seperate from the code base.
 - Commit messages should follow [[https:www.conventionalcommits.org/en/v1.0.0/][Conventional Commits 1.0.0]]