From 1854c30d4177ff88847e09474c88eda451fc3285 Mon Sep 17 00:00:00 2001
From: Scott Baker <scott@perturb.org>
Date: Sat, 23 Feb 2019 17:07:57 -0800
Subject: [PATCH 1/2] Update the documentation with clearer paths and info on
 sub-modules

---
 README.md | 25 +++++++++++++++----------
 1 file changed, 15 insertions(+), 10 deletions(-)

diff --git a/README.md b/README.md
index 013c6f93ac..2df21a5eaf 100644
--- a/README.md
+++ b/README.md
@@ -42,29 +42,34 @@ Documentation: [https://arduino-esp8266.readthedocs.io/en/2.5.0/](https://arduin
 [![Linux build status](https://travis-ci.org/esp8266/Arduino.svg)](https://travis-ci.org/esp8266/Arduino)
 
 - Install the current upstream Arduino IDE at the 1.8 level or later. The current version is at the [Arduino website](http://www.arduino.cc/en/main/software).
-- Go to Arduino directory
+- Go to your Arduino sketchbook directory
   - For Mac OS X, it is `Arduino.app` showing as the Arduino icon.  
     This location may be your `~/Downloads`, `~/Desktop` or even `/Applications`.
     ```bash
     cd <application-directory>/Arduino.app/Contents/Java
     ```
-  - For Linux, it is ~/arduino by default.
+  - For Linux, it is `~/arduino/` by default.
     ```bash
-    cd ~arduino
+    cd ~/arduino/
     ```
-- Clone this repository into hardware/esp8266com/esp8266 directory (or clone it elsewhere and create a symlink)
+
+- Clone this repository into `hardware/esp8266com/esp8266/` (or clone it elsewhere and create a symlink)
 ```bash
-cd hardware
-mkdir esp8266com
-cd esp8266com
-git clone https://github.com/esp8266/Arduino.git esp8266
+git clone https://github.com/esp8266/Arduino.git hardware/esp8266com/esp8266/
 ```
-- Download binary tools (you need Python 2.7)
+
+- This repo requires other tools (sub-modules) that we need to fetch
+```bash
+cd hardware/esp8266com/esp8266/
+git submodule update --init --recursive
+```
+
+- Download binary tools (requires Python 2.7)
 ```bash
 cd esp8266/tools
 python get.py
 ```
-- Restart Arduino
+- Restart the Arduino IDE
 
 ### Using PlatformIO
 

From 136663ac4c47430cb8c30ead6a1d2ef7ad1dc1d6 Mon Sep 17 00:00:00 2001
From: Scott Baker <scott@perturb.org>
Date: Mon, 25 Feb 2019 08:50:06 -0800
Subject: [PATCH 2/2] Fix a path because we had already CDd in to the parent
 dir

---
 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 2df21a5eaf..c73c8a018c 100644
--- a/README.md
+++ b/README.md
@@ -66,7 +66,7 @@ git submodule update --init --recursive
 
 - Download binary tools (requires Python 2.7)
 ```bash
-cd esp8266/tools
+cd tools/
 python get.py
 ```
 - Restart the Arduino IDE