From 4b5196fa3e57d276088775278e82793af82a5c1d Mon Sep 17 00:00:00 2001
From: rkcf <rkcf@rkcf.me>
Date: Sat, 4 Feb 2023 15:22:27 -0600
Subject: [PATCH] Update docs section on full project setup process

---
 README.org | 41 ++++++++++++++++++++++++++++++++++-------
 1 file changed, 34 insertions(+), 7 deletions(-)

diff --git a/README.org b/README.org
index 844c545..a4fc5e9 100644
--- a/README.org
+++ b/README.org
@@ -1,14 +1,43 @@
 * ESP32 Sequencer
-A basic step sequencer based on the esp32.
+A basic step sequencer based on the esp32-s3.
 
 ** Project Setup
-
+Clone the repository
 #+BEGIN_SRC shell
-idf.py add-dependency "lvgl/lvgl>=8.*"
+git clone git@gitea.rkcf.me:rkcf/esp32-sequencer.git
+cd esp32-sequencer
+#+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
+
+Add the dependencies. They will install upon building the project the first time.
+#+BEGIN_SRC shell
+idf.py add-dependency "espressif/esp_lcd_ili9341>=1.0.2"
+idf.py add-dependency "lvgl/lvgl>=8.3.0"
+#+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
 
 ** Pinout
-
 | ESP32 Pin | Function            | Peripheral Pin |
 |-----------+---------------------+----------------|
 |         5 | Clock LED           |                |
@@ -26,9 +55,7 @@ idf.py add-dependency "lvgl/lvgl>=8.*"
 |        41 | LED                 | LCD 8          |
 |        42 | SDO/MISO            | LCD 9          |
 
-
-** TFT LCD Screen
-Pinout
+*** TFT LCD Screen
 | LCD Pin | ESP32 Pin | Function  |
 |---------+-----------+-----------|
 |       1 |           | VCC (3V3) |