Skip to content

Commit 59ebaab

Browse files
committed
added a hint for git option "recursivly"
1 parent 706fe3c commit 59ebaab

File tree

1 file changed

+57
-30
lines changed

1 file changed

+57
-30
lines changed

doc/windows.md

Lines changed: 57 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,75 @@
1-
## Steps to install Arduino ESP32 support on Windows
1+
Steps to install Arduino ESP32 support on Windows
2+
-------------------------------------------------
3+
24
### Tested on 32 and 64 bit Windows 10 machines
35

4-
1. Download and install the latest Arduino IDE ```Windows Installer``` from [arduino.cc](https://www.arduino.cc/en/Main/Software)
5-
2. Download and install Git from [git-scm.com](https://git-scm.com/download/win)
6-
3. Start ```Git GUI``` and run through the following steps:
7-
- Select ```Clone Existing Repository```
8-
6+
1. Download and install the latest Arduino IDE `Windows Installer` from
7+
[arduino.cc](https://www.arduino.cc/en/Main/Software)
8+
9+
2. Download and install Git from
10+
[git-scm.com](https://git-scm.com/download/win)
11+
12+
3. Start `Git GUI` and run through the following steps:
13+
14+
- Select `Clone Existing Repository`
15+
916
![Step 1](win-gui-1.png)
10-
11-
- Select source and destination
12-
- Source Location: ```https://github.com/espressif/arduino-esp32.git```
13-
- Target Directory: ```C:/Users/[YOUR_USER_NAME]/Documents/Arduino/hardware/espressif/esp32```
14-
- Click ```Clone``` to start cloning the repository
15-
17+
18+
- Select source and destination
19+
20+
- Source Location: `https://github.com/espressif/arduino-esp32.git`
21+
22+
- Target Directory:
23+
`C:/Users/[YOUR_USER_NAME]/Documents/Arduino/hardware/espressif/esp32`
24+
25+
- **Attention**, please be sure you choose the recursively Option! If
26+
you don’t do, you will get problems with different WiFi libraries.
27+
28+
- Click `Clone` to start cloning the repository
29+
1630
![Step 2](win-gui-2.png)
31+
1732
![Step 3](win-gui-3.png)
18-
19-
- Open ```C:/Users/[YOUR_USER_NAME]/Documents/Arduino/hardware/espressif/esp32/tools``` and double-click ```get.exe```
20-
33+
34+
- Open
35+
`C:/Users/[YOUR_USER_NAME]/Documents/Arduino/hardware/espressif/esp32/tools`
36+
and double-click `get.exe`
37+
2138
![Step 4](win-gui-4.png)
22-
23-
- When ```get.exe``` finishes, you should see the following files in the directory
24-
39+
40+
- When `get.exe` finishes, you should see the following files in the
41+
directory
42+
2543
![Step 5](win-gui-5.png)
26-
27-
4. Plug your ESP32 board and wait for the drivers to install (or install manually any that might be required)
28-
5. Start Arduino IDE
29-
6. Select your board in ```Tools > Board``` menu
30-
7. Select the COM port that the board is attached to
31-
8. Compile and upload (You might need to hold the boot button while uploading)
44+
45+
4. Plug your ESP32 board and wait for the drivers to install (or install
46+
manually any that might be required)
47+
48+
5. Start Arduino IDE
49+
50+
6. Select your board in `Tools > Board` menu
51+
52+
7. Select the COM port that the board is attached to
53+
54+
8. Compile and upload (You might need to hold the boot button while uploading)
3255

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

3558
### How to update to the latest code
3659

37-
1. Start ```Git GUI``` and you should see the repository under ```Open Recent Repository```. Click on it!
60+
1. Start `Git GUI` and you should see the repository under `Open Recent
61+
Repository`. Click on it!
3862

3963
![Update Step 1](win-gui-update-1.png)
40-
41-
2. From menu ```Remote``` select ```Fetch from``` > ```origin```
64+
65+
2. From menu `Remote` select `Fetch from` \> `origin`
4266

4367
![Update Step 2](win-gui-update-2.png)
44-
45-
3. Wait for git to pull any changes and close ```Git GUI```
46-
4. Open ```C:/Users/[YOUR_USER_NAME]/Documents/Arduino/hardware/espressif/esp32/tools``` and double-click ```get.exe```
68+
69+
3. Wait for git to pull any changes and close `Git GUI`
70+
71+
4. Open
72+
`C:/Users/[YOUR_USER_NAME]/Documents/Arduino/hardware/espressif/esp32/tools`
73+
and double-click `get.exe`
4774

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

0 commit comments

Comments
 (0)