From ac36e5f5306836052ed08f95812b248fd77f9695 Mon Sep 17 00:00:00 2001 From: gojimmypi Date: Wed, 6 Jun 2018 15:58:01 -0700 Subject: [PATCH 1/8] Instructions update added correction for Windows 10 git install directory --- doc/installing.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/doc/installing.md b/doc/installing.md index 55b03fe32f..903b3a9b6e 100644 --- a/doc/installing.md +++ b/doc/installing.md @@ -35,7 +35,11 @@ This is the suggested installation method for contributors and library developer ### Instructions -- Open the console and go to Arduino directory. This can be either your *sketchbook* directory (usually `/Arduino`), or the directory of Arduino application itself, the choice is up to you. +- Open the console and go to Arduino directory. This can be either your *sketchbook* directory (usually `` or `/Arduino`), or the directory of Arduino application itself, the choice is up to you. For Windows 10 the directory will typically be: `C:\Users\{username}\Documents\hardware\` + +- Note that although the Arduino installer will use (for Windows) +`C:\Users\{username}\AppData\Local\Arduino15\packages\esp8266\hardware` this is not the recommended directory for the git version. (and it is probably best not to install both) + - Clone this repository into hardware/esp8266com/esp8266 directory. Alternatively, clone it elsewhere and create a symlink, if your OS supports them. ```bash From a5be2d65a5b52a4576ec85699795841219b97dbe Mon Sep 17 00:00:00 2001 From: gojimmypi Date: Thu, 7 Jun 2018 09:56:51 -0700 Subject: [PATCH 2/8] Update installing.md --- doc/installing.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/doc/installing.md b/doc/installing.md index 903b3a9b6e..55b03fe32f 100644 --- a/doc/installing.md +++ b/doc/installing.md @@ -35,11 +35,7 @@ This is the suggested installation method for contributors and library developer ### Instructions -- Open the console and go to Arduino directory. This can be either your *sketchbook* directory (usually `` or `/Arduino`), or the directory of Arduino application itself, the choice is up to you. For Windows 10 the directory will typically be: `C:\Users\{username}\Documents\hardware\` - -- Note that although the Arduino installer will use (for Windows) -`C:\Users\{username}\AppData\Local\Arduino15\packages\esp8266\hardware` this is not the recommended directory for the git version. (and it is probably best not to install both) - +- Open the console and go to Arduino directory. This can be either your *sketchbook* directory (usually `/Arduino`), or the directory of Arduino application itself, the choice is up to you. - Clone this repository into hardware/esp8266com/esp8266 directory. Alternatively, clone it elsewhere and create a symlink, if your OS supports them. ```bash From b9c4512df40610a29b2154bd57bddb39de27663d Mon Sep 17 00:00:00 2001 From: gojimmypi Date: Thu, 7 Jun 2018 11:48:50 -0700 Subject: [PATCH 3/8] Update installing.rst --- doc/installing.rst | 64 +++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 63 insertions(+), 1 deletion(-) diff --git a/doc/installing.rst b/doc/installing.rst index 015c211734..83e89c2d37 100644 --- a/doc/installing.rst +++ b/doc/installing.rst @@ -48,7 +48,69 @@ Prerequisites - terminal, console, or command prompt (depending on you 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\``) + +- 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 + +- 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 From f792e683ab6350de9725b490ee636252219f67a5 Mon Sep 17 00:00:00 2001 From: gojimmypi Date: Thu, 7 Jun 2018 12:58:09 -0700 Subject: [PATCH 4/8] Reminder for VisualMicro install clarifications --- doc/installing.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/installing.rst b/doc/installing.rst index 83e89c2d37..d977647a6f 100644 --- a/doc/installing.rst +++ b/doc/installing.rst @@ -52,7 +52,7 @@ 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\``) + *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. @@ -99,6 +99,8 @@ Instructions - Windows 10 - 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 From c5c4a095819593cac686e47896cf235f71fe2832 Mon Sep 17 00:00:00 2001 From: gojimmypi Date: Thu, 7 Jun 2018 13:46:07 -0700 Subject: [PATCH 5/8] tidy up links markup works differently in rst vs md --- doc/installing.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/doc/installing.rst b/doc/installing.rst index d977647a6f..0c62908078 100644 --- a/doc/installing.rst +++ b/doc/installing.rst @@ -44,7 +44,11 @@ Prerequisites - Arduino 1.6.8 (or newer, if you know what you are doing) - git -- python 2.7 +- Python_ 2.7. + +.. _Python: http://www.python.org/ + +__ Python_ - terminal, console, or command prompt (depending on you OS) - Internet connection @@ -99,7 +103,7 @@ Instructions - Windows 10 - 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 +- 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 From 5ce724d257c140ddec92eddde5fba549cc6fb591 Mon Sep 17 00:00:00 2001 From: gojimmypi Date: Thu, 7 Jun 2018 14:01:12 -0700 Subject: [PATCH 6/8] formatting cleanup --- doc/installing.rst | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/doc/installing.rst b/doc/installing.rst index 0c62908078..99a0e7ab9a 100644 --- a/doc/installing.rst +++ b/doc/installing.rst @@ -42,14 +42,10 @@ 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. - -.. _Python: http://www.python.org/ - -__ Python_ -- 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 - Windows 10 From 8a6c849255adcd138ff5d9786c029fafb0ff28a2 Mon Sep 17 00:00:00 2001 From: gojimmypi Date: Tue, 12 Jun 2018 11:08:36 -0700 Subject: [PATCH 7/8] corrected default sketch directory the default Arduino Sketchbook directory is C:\users\{username}\Documents\Arduino (thanks @Juppit) https://github.com/esp8266/Arduino/pull/4797#issuecomment-396650538 --- doc/installing.rst | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/doc/installing.rst b/doc/installing.rst index 99a0e7ab9a..a416dd9aa0 100644 --- a/doc/installing.rst +++ b/doc/installing.rst @@ -33,6 +33,10 @@ You may optionally use *staging* boards manager package link: This may contain some new features, but at the same time, some things might be broken. +For more information on the Arduino Board Manager, see: + +- https://www.arduino.cc/en/Guide/Libraries + Using git version ----------------- @@ -50,26 +54,33 @@ Prerequisites Instructions - Windows 10 ~~~~~~~~~~~~ +- First, make sure you don't already have the ESP8266 library installed using the Board Manager (see above) + +- Install git for Windows (if not already; see https://git-scm.com/download/win) - 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}``) + *sketchbook* directory (usually ``C:\users\{username}\Documents\Arduino`` where the environment variable ``%USERPROFILE%`` usually contains ``C:\users\{username}``) - Clone this repository into hardware/esp8266com/esp8266 directory. .. code:: bash - cd %USERPROFILE%\Documents\ + cd %USERPROFILE%\Documents\Arduino\ + mkdir hardware 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}\``: + You should end up with the following directory structure in + + ``C:\Users\{your username}\Documents\`` .. code:: bash - Documents + Arduino | + --- libraries --- hardware | --- esp8266com From 8d8ad419924dd1d7d54ab1368615ec09eabab037 Mon Sep 17 00:00:00 2001 From: gojimmypi Date: Wed, 13 Jun 2018 10:46:35 -0700 Subject: [PATCH 8/8] check for directory before creating --- doc/installing.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/installing.rst b/doc/installing.rst index a416dd9aa0..f86eb1f0cb 100644 --- a/doc/installing.rst +++ b/doc/installing.rst @@ -66,9 +66,9 @@ Instructions - Windows 10 .. code:: bash cd %USERPROFILE%\Documents\Arduino\ - mkdir hardware + if not exist hardware mkdir hardware cd hardware - mkdir esp8266com + if not exist esp8266com mkdir esp8266com cd esp8266com git clone https://github.com/esp8266/Arduino.git esp8266