Skip to content

Commit e0bc4c8

Browse files
authored
Update installing.rst
Replaces and based on esp8266#5602 Fixes esp8266#5583
1 parent 60d6ed5 commit e0bc4c8

File tree

1 file changed

+18
-10
lines changed

1 file changed

+18
-10
lines changed

doc/installing.rst

+18-10
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,15 @@ Instructions - Windows 10
101101
--- boards.txt
102102
--- LICENSE
103103
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+
104113
- Download binary tools
105114
106115
.. code:: bash
@@ -112,16 +121,6 @@ Instructions - Windows 10
112121
113122
- If using the Arduino IDE for Visual Studio (https://www.visualmicro.com/), be sure to click Tools - Visual Micro - Rescan Toolchains and Libraries
114123
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-
125124
- When later updating your local library, goto the esp8266 directory and do a git pull
126125
127126
.. code:: bash
@@ -176,6 +175,15 @@ Instructions - Other OS
176175
--- boards.txt
177176
--- LICENSE
178177
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.
186+
179187
- Download binary tools
180188
181189
.. code:: bash

0 commit comments

Comments
 (0)