Skip to content
Merged
72 changes: 68 additions & 4 deletions doc/installing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,77 @@ developers.
Prerequisites
~~~~~~~~~~~~~

- Arduino 1.6.8 (or newer, if you know what you are doing)
- Arduino 1.6.8 (or newer, current working version is 1.8.5)
- git
- python 2.7
- terminal, console, or command prompt (depending on you OS)
- Python_ 2.7 (http://python.org)
- terminal, console, or command prompt (depending on your OS)
- Internet connection

Instructions
Instructions - Windows 10
~~~~~~~~~~~~

- Open a command prompt (cmd) and go to Arduino default directory. This is typically the
*sketchbook* directory (usually ``C:\users\{username}\Documents\`` where the environment variable ``%USERPROFILE%`` usually contains ``C:\users\{username}``)

- Clone this repository into hardware/esp8266com/esp8266 directory.

.. code:: bash

cd %USERPROFILE%\Documents\
cd hardware
mkdir esp8266com
cd esp8266com
git clone https://github.com/esp8266/Arduino.git esp8266

You should end up with the following directory structure in ``C:\Users\{your username}\``:

.. code:: bash

Documents
|
--- hardware
|
--- esp8266com
|
--- esp8266
|
--- bootloaders
--- cores
--- doc
--- libraries
--- package
--- tests
--- tools
--- variants
--- platform.txt
--- programmers.txt
--- README.md
--- boards.txt
--- LICENSE

- Download binary tools

.. code:: bash

cd esp8266/tools
python get.py

- Restart Arduino

- If using the Arduino IDE for Visual Studio (https://www.visualmicro.com/), be sure to click Tools - Visual Micro - Rescan Toolchains and Libraries

- When later updating your local library, goto the esp8266 directory and do a git pull

.. code:: bash

cd %USERPROFILE%\Documents\hardware\esp8266com\esp8266
git status
git pull

Note that you could, in theory install in ``C:\Program Files (x86)\Arduino\hardware`` however this has security implications, not to mention the directory often gets blown away when re-installing Arduino IDE. It does have the benefit (or drawback, depending on your perspective) - of being available to all users on your PC that use Arduino.


Instructions - Other OS
~~~~~~~~~~~~

- Open the console and go to Arduino directory. This can be either your
Expand Down