Skip to content

Commit

Permalink
remove Git Bash-based Windows instructions and assume Git Command Pro…
Browse files Browse the repository at this point in the history
…mpt integration instead (#510, #632, #897)
  • Loading branch information
andycarle committed May 4, 2022
1 parent 2cb5f55 commit 392531a
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 14 deletions.
14 changes: 8 additions & 6 deletions documentation/Moddable SDK - Getting Started.md
Original file line number Diff line number Diff line change
Expand Up @@ -257,32 +257,34 @@ The Moddable SDK requires Windows 8.1 or newer and Microsoft Visual Studio Commu
<a id="win-update"></a>
### 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
Expand Down
10 changes: 5 additions & 5 deletions documentation/devices/esp32.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions documentation/devices/esp8266.md
Original file line number Diff line number Diff line change
Expand Up @@ -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\<user>\esp
cd %USERPROFILE%\esp
git clone https://github.com/espressif/ESP8266_RTOS_SDK.git
```
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 392531a

Please sign in to comment.