From 5fbe571a0f9ab0d36c2bcd46c1fe0f75ca2a5f70 Mon Sep 17 00:00:00 2001 From: Andy Carle Date: Wed, 4 May 2022 17:37:38 -0600 Subject: [PATCH] remove Git Bash-based Windows instructions and assume Git Command Prompt integration instead (#510, #632, #897) --- documentation/Moddable SDK - Getting Started.md | 14 ++++++++------ documentation/devices/esp32.md | 10 +++++----- documentation/devices/esp8266.md | 6 +++--- 3 files changed, 16 insertions(+), 14 deletions(-) diff --git a/documentation/Moddable SDK - Getting Started.md b/documentation/Moddable SDK - Getting Started.md index 0c6c40ac0c..9a8920ab64 100644 --- a/documentation/Moddable SDK - Getting Started.md +++ b/documentation/Moddable SDK - Getting Started.md @@ -257,32 +257,34 @@ The Moddable SDK requires Windows 8.1 or newer and Microsoft Visual Studio Commu ### Updating -The Moddable SDK tools are frequently updated with improvements and added functionality. You should occasionally update your host environment by following these steps: +The Moddable SDK tools are frequently updated with improvements and added functionality. You should occasionally update your host environment by following these steps. + + > Note: The following commands should all be run in the "x86 Native Tools Command Prompt for VS 2022" command line console. -1. Update your local clone of the [Moddable repository](https://github.com/Moddable-OpenSource/moddable). For instance, using `Git Bash`: +1. Update your local clone of the [Moddable repository](https://github.com/Moddable-OpenSource/moddable): ```text - cd $MODDABLE + cd %MODDABLE% git pull ``` > Note that if you have any local changes to Moddable repository files, you may need to stash your changes and then reapply them after pulling: ```text - cd $MODDABLE + cd %MODDABLE% git stash push git pull git stash pop ``` -2. Launch the "x86 Native Tools Command Prompt for VS 2022" command line console. Delete any existing Moddable SDK build outputs: +2. Delete any existing Moddable SDK build outputs: ```text cd %MODDABLE%\build\makefiles\win build clean ``` -3. In the "x86 Native Tools Command Prompt for VS 2022" command line console, build the Moddable command line tools, simulator, and debugger: +3. Build the Moddable command line tools, simulator, and debugger: ```text cd %MODDABLE%\build\makefiles\win diff --git a/documentation/devices/esp32.md b/documentation/devices/esp32.md index 284c295e46..531d9a40bd 100644 --- a/documentation/devices/esp32.md +++ b/documentation/devices/esp32.md @@ -406,17 +406,17 @@ The Moddable SDK build for ESP32 currently uses ESP-IDF v4.4 on commit `c29343` The installer will offer to clone the ESP-IDF git repository for you. If you choose this option, select the "v4.4 (release version)" option and clone into a a directory called `esp32\esp-idf` within your home folder. -4. If you did not clone the ESP-IDF using the ESP-IDF Windows Installer, create an `esp32` directory in your home folder, either from File Explorer or a terminal. For instance, in Git Bash: +4. If you did not clone the ESP-IDF using the ESP-IDF Windows Installer, create an `esp32` directory in your home folder, either from File Explorer or a Command Prompt: ```text - cd ~ + cd %USERPROFILE% mkdir esp32 ``` 5. If you did not clone the ESP-IDF using the ESP-IDF Windows Installer, clone the `ESP-IDF` Github repository into your `~/esp32` directory. Make sure to specify the `--recursive` option. Then checkout commit `c29343`: ```text - cd ~/esp32 + cd %USERPROFILE%\esp32 git clone --recursive https://github.com/espressif/esp-idf.git cd esp-idf git checkout c29343 @@ -530,10 +530,10 @@ To ensure that your build environment is up to date, perform the following steps If you use the installer to clone the ESP-IDF, please follow the instructions in the next step to update to commit `c29343`. -2. If you did not clone the ESP-IDF using the ESP-IDF Windows Installer, clone the `ESP-IDF` Github repository into your `~/esp32` directory. Make sure to specify the `--recursive` option. Then checkout commit `c29343`. For instance, in **Git Bash**: +2. If you did not clone the ESP-IDF using the ESP-IDF Windows Installer, clone the `ESP-IDF` Github repository into your `~/esp32` directory. Make sure to specify the `--recursive` option. Then checkout commit `c29343`: ```text - cd ~/esp32 + cd %USERPROFILE%\esp32 git clone --recursive https://github.com/espressif/esp-idf.git cd esp-idf git checkout c29343 diff --git a/documentation/devices/esp8266.md b/documentation/devices/esp8266.md index 396c610636..8df58d5c89 100644 --- a/documentation/devices/esp8266.md +++ b/documentation/devices/esp8266.md @@ -226,7 +226,7 @@ The Moddable SDK build for ESP8266 currently uses ESP8266 Arduino Core 2.3.0 and 8. Clone the [ESP8266 SDK based on FreeRTOS](https://github.com/espressif/ESP8266_RTOS_SDK) repository into the `~/esp` directory: ```text - cd C:\Users\\esp + cd %USERPROFILE%\esp git clone https://github.com/espressif/ESP8266_RTOS_SDK.git ``` @@ -314,10 +314,10 @@ To ensure that your build environment is up to date, perform the following steps 1. Download the [ESP8266 core for Arduino repository](https://github.com/esp8266/Arduino/releases/download/2.3.0/esp8266-2.3.0.zip). Copy the extracted `esp8266-2.3.0` folder into your `esp` directory. -2. Update your cloned copy of the [ESP8266 SDK based on FreeRTOS](https://github.com/espressif/ESP8266_RTOS_SDK) and select the release/v3.2 branch. For instance, using `Git Bash`: +2. Update your cloned copy of the [ESP8266 SDK based on FreeRTOS](https://github.com/espressif/ESP8266_RTOS_SDK) and select the release/v3.2 branch: ```text - cd ~/esp/ESP8266_RTOS_SDK + cd %USERPROFILE%\esp\ESP8266_RTOS_SDK git fetch git checkout release/v3.2 git pull