From 29e0cc3b8e7691897ccd366af798b037647ae677 Mon Sep 17 00:00:00 2001
From: Penguin <penguin@epenguin.net>
Date: Sun, 21 Nov 2021 15:35:32 -0600
Subject: [PATCH] updated readme instructions

---
 README.md | 91 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 88 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 74097e4c..97930e5c 100644
--- a/README.md
+++ b/README.md
@@ -4,19 +4,104 @@ Warning: This only works for x86\_64 linux machines atm. Windows development is
 
 As of right now, only the *new* command works. Everything else is not implemented yet. However, *new* does most of the heavy lifting so the other commands will come quickly once it is finished and polished.
 
+### Prerequisites
+
+You need the following things installed for igloo+eSF to work properly:
+ - openocd
+ - rust (nightly preferred becuase it's just better)
+ - toolchains (more below)
+
+In the future, these things will just be bundled with eSF. The problem with some toolchains is dependency matching for various distros.
+
+#### Toolchains
+
+Loose naming convention for toolchains:
+<arch>-<vendor>-<target os>-<host os>-<abi>
+
+ - arm-none-eabi:
+  - Toolchain targetting the embedded ABI for arm
+  - Debian/Ubuntu:
+  ```
+  sudo apt-get install gcc-arm-none-eabi binutils-arm-none-eabi gdb-arm-none-eabi
+  ```
+
+  - Arch
+  ```
+  sudo pacman -S arm-none-eabi-binutils arm-none-eabi-gcc arm-none-eabi-gdb arm-none-eabi-newlib
+  ```
+
+ **NOTE:** If you run into an issue when running arm-none-eabi-gdb where it needs libncurses.so.5 on Ubuntu/Debian, install this package:
+ ```
+ sudo apt-get install libncurses5
+ ```
+
+ - avr-*
+ ```
+ Debian:
+ (To be added)
+
+ Arch:
+ sudo pacman -S avr-binutils avr-gcc avr-gdb avr-libc avrdude
+ ```
+
+#### OpenOCD
+
+It is recommended that you download the zip here:
+https://github.com/xpack-dev-tools/openocd-xpack/releases
+
+Otherwise, you can install it from your package manager:
+
+Arch
+```
+sudo pacman -S openocd
+```
+
+Debian/Ubuntu
+```
+sudo apt install openocd
+```
+
+
+#### Rustlang
+
+Doesn't get any easier than this: https://www.rust-lang.org/tools/install
+
 ### Instructions for testing
+
+**WARNING**: DO NOT COPY AND PASTE THESE INSTRUCTIONS. READ THROUGH THEM.
+
 ```
 cd ~
+
+# NOTE: If you plan on using the toolchain packaged with ESF, which may or may not work right now, clone recursively:
+git clone --recursive https://git.epenguin.net/ePenguin/ePenguin-Software-Framework.git
+# Otherwise
 git clone https://git.epenguin.net/ePenguin/ePenguin-Software-Framework.git
+
 git clone https://git.epenguin.net/ePenguin/ePenguin-Igloo.git
 sudo chmod -R u+x ~/ePenguin-Software-Framework/
 sudo chmod -R u+x ~/ePenguin-Igloo/
 export ESF_DIR=~/ePenguin-Software-Framework
-alias igloo=~/ePenguin-Igloo/target/release/igloo
+alias igloo_rls=~/ePenguin-Igloo/target/release/igloo
+alias igloo_dbg=~/ePenguin-Igloo/target/debug/igloo
+alias igloo=igloo_dbg
+
+# Building
+cd ~/ePenguin-Igloo
+
+# Debug build is default
+cargo build
+
+# For release build
+# cargo build --release
+
 igloo
 ```
+
 You should see a help menu thrown at you for more instruction.
 
+I've aliased igloo_dbg for igloo, but you can use the release version if you want better performance and faster compile times. It is highly recommended to use the debug version right now, though.
+
 ### Generating a new project
 ```
 igloo new <project_name> --target=<mcu>
@@ -35,7 +120,7 @@ make
 ### Instructions for running
 I'm not including these steps because openocd releases vary with target configs. I recommend you download a release from https://openocd.org and unzip it there. Downloading via a package manager almost guarantees you're going to be missing target scripts.
 
-In the future, igloo will handle all of this.
+At some point in the future, I'm going to fork openocd just so I can make sure default board config scripts are 100% available because right now it's really hit or miss on various distros.
 
 for the e54 xplained
 ```
@@ -51,7 +136,7 @@ If the E54 xplained cfg isn't found for some reason, try this:
 ```
 echo "
 #
-# Atmel SAMD21 Xplained Pro evaluation kit.
+# Atmel SAME54 Xplained Pro evaluation kit.
 #
 
 source [find interface/cmsis-dap.cfg]