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
+18-10
Original file line number
Diff line number
Diff line change
@@ -101,6 +101,15 @@ Instructions - Windows 10
101
101
--- boards.txt
102
102
--- LICENSE
103
103
104
+
- Initialize the submodules
105
+
106
+
.. code:: bash
107
+
108
+
cd %USERPROFILE%\Documents\hardware\esp8266com\esp8266
109
+
git submodules update --init
110
+
111
+
If error messages about missing files related to ``SoftwareSerial`` are encountered during the build process, it should be because this step was missed and is required.
112
+
104
113
- Download binary tools
105
114
106
115
.. code:: bash
@@ -112,16 +121,6 @@ Instructions - Windows 10
112
121
113
122
- If using the Arduino IDE for Visual Studio (https://www.visualmicro.com/), be sure to click Tools - Visual Micro - Rescan Toolchains and Libraries
114
123
115
-
- You may see some error messages about missing files related to the
116
-
``SoftwareSerial`` library. These are because the ESP8266 version
117
-
of this library has been moved to a separate git submodule. In
118
-
order to get rid of these messages, initialize the submodule:
119
-
120
-
.. code:: bash
121
-
122
-
cd %USERPROFILE%\Documents\hardware\esp8266com\esp8266
123
-
git submodules update --init
124
-
125
124
- When later updating your local library, goto the esp8266 directory and do a git pull
126
125
127
126
.. code:: bash
@@ -176,6 +175,15 @@ Instructions - Other OS
176
175
--- boards.txt
177
176
--- LICENSE
178
177
178
+
- Initialize the submodules
179
+
180
+
.. code:: bash
181
+
182
+
cd esp8266
183
+
git submodules update --init
184
+
185
+
If error messages about missing files related to ``SoftwareSerial`` are encountered during the build process, it should be because this step was missed and is required.
0 commit comments