DOCUMENTATION: Moved installation instructions to separate page (#561)
* 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
19
docs/arduino-ide/debian_ubuntu.md
Normal file
@ -0,0 +1,19 @@
|
||||
Installation instructions for Debian / Ubuntu OS
|
||||
=================================================
|
||||
|
||||
- Install latest Arduino IDE from [arduino.cc](https://www.arduino.cc/en/Main/Software)
|
||||
- Open Terminal and execute the following command (copy->paste and hit enter):
|
||||
|
||||
```bash
|
||||
sudo usermod -a -G dialout $USER && \
|
||||
sudo apt-get install git && \
|
||||
wget https://bootstrap.pypa.io/get-pip.py && \
|
||||
sudo python get-pip.py && \
|
||||
sudo pip install pyserial && \
|
||||
mkdir -p ~/Arduino/hardware/espressif && \
|
||||
cd ~/Arduino/hardware/espressif && \
|
||||
git clone https://github.com/espressif/arduino-esp32.git esp32 && \
|
||||
cd esp32/tools/ && \
|
||||
python get.py
|
||||
```
|
||||
- Restart Arduino IDE
|
16
docs/arduino-ide/fedora.md
Normal file
@ -0,0 +1,16 @@
|
||||
Installation instructions for Fedora
|
||||
=====================================
|
||||
|
||||
- Install the latest Arduino IDE from [arduino.cc](https://www.arduino.cc/en/Main/Software). `$ sudo dnf -y install arduino` will most likely install an older release.
|
||||
- Open Terminal and execute the following command (copy->paste and hit enter):
|
||||
|
||||
```bash
|
||||
sudo usermod -a -G dialout $USER && \
|
||||
sudo dnf install git python3-pip python3-pyserial && \
|
||||
mkdir -p ~/Arduino/hardware/espressif && \
|
||||
cd ~/Arduino/hardware/espressif && \
|
||||
git clone https://github.com/espressif/arduino-esp32.git esp32 && \
|
||||
cd esp32/tools/ && \
|
||||
python get.py
|
||||
```
|
||||
- Restart Arduino IDE
|
14
docs/arduino-ide/mac.md
Normal file
@ -0,0 +1,14 @@
|
||||
Installation instructions for Mac OS
|
||||
=====================================
|
||||
|
||||
- Install latest Arduino IDE from [arduino.cc](https://www.arduino.cc/en/Main/Software)
|
||||
- Open Terminal and execute the following command (copy->paste and hit enter):
|
||||
|
||||
```bash
|
||||
mkdir -p ~/Documents/Arduino/hardware/espressif && \
|
||||
cd ~/Documents/Arduino/hardware/espressif && \
|
||||
git clone https://github.com/espressif/arduino-esp32.git esp32 && \
|
||||
cd esp32/tools/ && \
|
||||
python get.py
|
||||
```
|
||||
- Restart Arduino IDE
|
BIN
docs/arduino-ide/win-screenshots/arduino-ide.png
Normal file
After Width: | Height: | Size: 186 KiB |
BIN
docs/arduino-ide/win-screenshots/win-gui-1.png
Normal file
After Width: | Height: | Size: 27 KiB |
BIN
docs/arduino-ide/win-screenshots/win-gui-2.png
Normal file
After Width: | Height: | Size: 36 KiB |
BIN
docs/arduino-ide/win-screenshots/win-gui-3.png
Normal file
After Width: | Height: | Size: 27 KiB |
BIN
docs/arduino-ide/win-screenshots/win-gui-4.png
Normal file
After Width: | Height: | Size: 36 KiB |
BIN
docs/arduino-ide/win-screenshots/win-gui-5.png
Normal file
After Width: | Height: | Size: 84 KiB |
BIN
docs/arduino-ide/win-screenshots/win-gui-update-1.png
Normal file
After Width: | Height: | Size: 27 KiB |
BIN
docs/arduino-ide/win-screenshots/win-gui-update-2.png
Normal file
After Width: | Height: | Size: 39 KiB |
49
docs/arduino-ide/windows.md
Normal file
@ -0,0 +1,49 @@
|
||||
## 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```
|
||||
|
||||

|