You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/installing.rst
+79-4Lines changed: 79 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -33,6 +33,10 @@ You may optionally use *staging* boards manager package link:
33
33
This may contain some new features, but at the same time, some things
34
34
might be broken.
35
35
36
+
For more information on the Arduino Board Manager, see:
37
+
38
+
- https://www.arduino.cc/en/Guide/Libraries
39
+
36
40
Using git version
37
41
-----------------
38
42
@@ -42,13 +46,84 @@ developers.
42
46
Prerequisites
43
47
~~~~~~~~~~~~~
44
48
45
-
- Arduino 1.6.8 (or newer, if you know what you are doing)
49
+
- Arduino 1.6.8 (or newer, current working version is 1.8.5)
46
50
- git
47
-
- python 2.7
48
-
- terminal, console, or command prompt (depending on you OS)
51
+
- Python_ 2.7 (http://python.org)
52
+
- terminal, console, or command prompt (depending on your OS)
49
53
- Internet connection
50
54
51
-
Instructions
55
+
Instructions - Windows 10
56
+
~~~~~~~~~~~~
57
+
- First, make sure you don't already have the ESP8266 library installed using the Board Manager (see above)
58
+
59
+
- Install git for Windows (if not already; see https://git-scm.com/download/win)
60
+
61
+
- Open a command prompt (cmd) and go to Arduino default directory. This is typically the
62
+
*sketchbook* directory (usually ``C:\users\{username}\Documents\Arduino`` where the environment variable ``%USERPROFILE%`` usually contains ``C:\users\{username}``)
63
+
64
+
- Clone this repository into hardware/esp8266com/esp8266 directory.
You should end up with the following directory structure in
76
+
77
+
``C:\Users\{your username}\Documents\``
78
+
79
+
.. code:: bash
80
+
81
+
Arduino
82
+
|
83
+
--- libraries
84
+
--- hardware
85
+
|
86
+
--- esp8266com
87
+
|
88
+
--- esp8266
89
+
|
90
+
--- bootloaders
91
+
--- cores
92
+
--- doc
93
+
--- libraries
94
+
--- package
95
+
--- tests
96
+
--- tools
97
+
--- variants
98
+
--- platform.txt
99
+
--- programmers.txt
100
+
--- README.md
101
+
--- boards.txt
102
+
--- LICENSE
103
+
104
+
- Download binary tools
105
+
106
+
.. code:: bash
107
+
108
+
cd esp8266/tools
109
+
python get.py
110
+
111
+
- Restart Arduino
112
+
113
+
- If using the Arduino IDE for Visual Studio (https://www.visualmicro.com/), be sure to click Tools - Visual Micro - Rescan Toolchains and Libraries
114
+
115
+
- When later updating your local library, goto the esp8266 directory and do a git pull
116
+
117
+
.. code:: bash
118
+
119
+
cd %USERPROFILE%\Documents\hardware\esp8266com\esp8266
120
+
git status
121
+
git pull
122
+
123
+
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.
0 commit comments