Skip to content

added a hint for git option "recursivly" #159

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 57 additions & 30 deletions doc/windows.md
Original file line number Diff line number Diff line change
@@ -1,48 +1,75 @@
## Steps to install Arduino ESP32 support on Windows
Steps to install Arduino ESP32 support on Windows
-------------------------------------------------

### Tested on 32 and 64 bit Windows 10 machines

1. Download and install the latest Arduino IDE ```Windows Installer``` from [arduino.cc](https://www.arduino.cc/en/Main/Software)
2. Download and install Git from [git-scm.com](https://git-scm.com/download/win)
3. Start ```Git GUI``` and run through the following steps:
- Select ```Clone Existing Repository```

1. Download and install the latest Arduino IDE `Windows Installer` from
[arduino.cc](https://www.arduino.cc/en/Main/Software)

2. Download and install Git from
[git-scm.com](https://git-scm.com/download/win)

3. Start `Git GUI` and run through the following steps:

- Select `Clone Existing Repository`

![Step 1](win-gui-1.png)

- Select source and destination
- Source Location: ```https://github.com/espressif/arduino-esp32.git```
- Target Directory: ```C:/Users/[YOUR_USER_NAME]/Documents/Arduino/hardware/espressif/esp32```
- Click ```Clone``` to start cloning the repository


- Select source and destination

- Source Location: `https://github.com/espressif/arduino-esp32.git`

- Target Directory:
`C:/Users/[YOUR_USER_NAME]/Documents/Arduino/hardware/espressif/esp32`

- **Attention**, please be sure you choose the recursively Option! If
you don’t do, you will get problems with different WiFi libraries.

- Click `Clone` to start cloning the repository

![Step 2](win-gui-2.png)

![Step 3](win-gui-3.png)

- Open ```C:/Users/[YOUR_USER_NAME]/Documents/Arduino/hardware/espressif/esp32/tools``` and double-click ```get.exe```


- Open
`C:/Users/[YOUR_USER_NAME]/Documents/Arduino/hardware/espressif/esp32/tools`
and double-click `get.exe`

![Step 4](win-gui-4.png)

- When ```get.exe``` finishes, you should see the following files in the directory


- When `get.exe` finishes, you should see the following files in the
directory

![Step 5](win-gui-5.png)

4. Plug your ESP32 board and wait for the drivers to install (or install manually any that might be required)
5. Start Arduino IDE
6. Select your board in ```Tools > Board``` menu
7. Select the COM port that the board is attached to
8. Compile and upload (You might need to hold the boot button while uploading)

4. Plug your ESP32 board and wait for the drivers to install (or install
manually any that might be required)

5. Start Arduino IDE

6. Select your board in `Tools > Board` menu

7. Select the COM port that the board is attached to

8. Compile and upload (You might need to hold the boot button while uploading)

![Arduino IDE Example](arduino-ide.png)

### How to update to the latest code

1. Start ```Git GUI``` and you should see the repository under ```Open Recent Repository```. Click on it!
1. Start `Git GUI` and you should see the repository under `Open Recent
Repository`. Click on it!

![Update Step 1](win-gui-update-1.png)
2. From menu ```Remote``` select ```Fetch from``` > ```origin```

2. From menu `Remote` select `Fetch from` \> `origin`

![Update Step 2](win-gui-update-2.png)

3. Wait for git to pull any changes and close ```Git GUI```
4. Open ```C:/Users/[YOUR_USER_NAME]/Documents/Arduino/hardware/espressif/esp32/tools``` and double-click ```get.exe```

3. Wait for git to pull any changes and close `Git GUI`

4. Open
`C:/Users/[YOUR_USER_NAME]/Documents/Arduino/hardware/espressif/esp32/tools`
and double-click `get.exe`

![Step 4](win-gui-4.png)