* DOCUMENTATION: Moved installation instructions to separate page * Added Fedora to contents table * Added Issue/Bug Report section to README * Some minor improvements * DOCUMENTATION: Rename directory doc to docs * Also move ISSUE_TEMPLATE.md to docs directory * DOCUMENTATION: Use current repo's files * This makes it consistent instead of having few local and few pointing to espressif/arduino-esp32 by all linking to local files * DOCUMENTATION: Fix hyperlink to issue/bug template in contents * DOCUMENTATION: contents: supress platform specific installation instruction
50 lines
2.2 KiB
Markdown
50 lines
2.2 KiB
Markdown
## 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```
|
|
|
|

|
|
|
|
- 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```
|
|
- Change this to your Sketchbook Location if you have a different directory listed underneath the "Sketchbook location" in Arduino preferences.
|
|
- Click ```Clone``` to start cloning the repository
|
|
|
|

|
|

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

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

|
|
|
|
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)
|
|
|
|

|
|
|
|
### How to update to the latest code
|
|
|
|
1. Start ```Git GUI``` and you should see the repository under ```Open Recent Repository```. Click on it!
|
|
|
|

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

|
|
|
|
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```
|
|
|
|

|