Skip to content

Commit 392531a

Browse files
committed
remove Git Bash-based Windows instructions and assume Git Command Prompt integration instead (#510, #632, #897)
1 parent 2cb5f55 commit 392531a

File tree

3 files changed

+16
-14
lines changed

3 files changed

+16
-14
lines changed

documentation/Moddable SDK - Getting Started.md

+8-6
Original file line numberDiff line numberDiff line change
@@ -257,32 +257,34 @@ The Moddable SDK requires Windows 8.1 or newer and Microsoft Visual Studio Commu
257257
<a id="win-update"></a>
258258
### Updating
259259

260-
The Moddable SDK tools are frequently updated with improvements and added functionality. You should occasionally update your host environment by following these steps:
260+
The Moddable SDK tools are frequently updated with improvements and added functionality. You should occasionally update your host environment by following these steps.
261+
262+
> Note: The following commands should all be run in the "x86 Native Tools Command Prompt for VS 2022" command line console.
261263

262-
1. Update your local clone of the [Moddable repository](https://github.com/Moddable-OpenSource/moddable). For instance, using `Git Bash`:
264+
1. Update your local clone of the [Moddable repository](https://github.com/Moddable-OpenSource/moddable):
263265

264266
```text
265-
cd $MODDABLE
267+
cd %MODDABLE%
266268
git pull
267269
```
268270

269271
> 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:
270272

271273
```text
272-
cd $MODDABLE
274+
cd %MODDABLE%
273275
git stash push
274276
git pull
275277
git stash pop
276278
```
277279

278-
2. Launch the "x86 Native Tools Command Prompt for VS 2022" command line console. Delete any existing Moddable SDK build outputs:
280+
2. Delete any existing Moddable SDK build outputs:
279281

280282
```text
281283
cd %MODDABLE%\build\makefiles\win
282284
build clean
283285
```
284286

285-
3. In the "x86 Native Tools Command Prompt for VS 2022" command line console, build the Moddable command line tools, simulator, and debugger:
287+
3. Build the Moddable command line tools, simulator, and debugger:
286288

287289
```text
288290
cd %MODDABLE%\build\makefiles\win

documentation/devices/esp32.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -406,17 +406,17 @@ The Moddable SDK build for ESP32 currently uses ESP-IDF v4.4 on commit `c29343`
406406
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.
407407
408408
409-
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:
409+
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:
410410
411411
```text
412-
cd ~
412+
cd %USERPROFILE%
413413
mkdir esp32
414414
```
415415
416416
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`:
417417
418418
```text
419-
cd ~/esp32
419+
cd %USERPROFILE%\esp32
420420
git clone --recursive https://github.com/espressif/esp-idf.git
421421
cd esp-idf
422422
git checkout c29343
@@ -530,10 +530,10 @@ To ensure that your build environment is up to date, perform the following steps
530530
If you use the installer to clone the ESP-IDF, please follow the instructions in the next step to update to commit `c29343`.
531531

532532

533-
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**:
533+
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`:
534534

535535
```text
536-
cd ~/esp32
536+
cd %USERPROFILE%\esp32
537537
git clone --recursive https://github.com/espressif/esp-idf.git
538538
cd esp-idf
539539
git checkout c29343

documentation/devices/esp8266.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,7 @@ The Moddable SDK build for ESP8266 currently uses ESP8266 Arduino Core 2.3.0 and
226226
8. Clone the [ESP8266 SDK based on FreeRTOS](https://github.com/espressif/ESP8266_RTOS_SDK) repository into the `~/esp` directory:
227227
228228
```text
229-
cd C:\Users\<user>\esp
229+
cd %USERPROFILE%\esp
230230
git clone https://github.com/espressif/ESP8266_RTOS_SDK.git
231231
```
232232
@@ -314,10 +314,10 @@ To ensure that your build environment is up to date, perform the following steps
314314

315315
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.
316316

317-
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`:
317+
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:
318318

319319
```text
320-
cd ~/esp/ESP8266_RTOS_SDK
320+
cd %USERPROFILE%\esp\ESP8266_RTOS_SDK
321321
git fetch
322322
git checkout release/v3.2
323323
git pull

0 commit comments

Comments
 (0)