Skip to content

Commit 324eb56

Browse files
phrxmddevyte
authored andcommitted
Add fix for SoftwareSerial submodule errors to documentation (#5602)
* Add fix for SoftwareSerial submodule errors to documentation * Update installing.rst Replaces and based on #5602 Fixes #5583 * Update installing.rst Remove forgotten section Add update section for Other OS
1 parent 570b9a6 commit 324eb56

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

Diff for: doc/installing.rst

+26
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
@@ -166,6 +175,15 @@ Instructions - Other OS
166175
--- boards.txt
167176
--- LICENSE
168177
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+
169187
- Download binary tools
170188
171189
.. code:: bash
@@ -174,3 +192,11 @@ Instructions - Other OS
174192
python get.py
175193
176194
- Restart Arduino
195+
196+
- When later updating your local library, goto the esp8266 directory and do a git pull
197+
198+
.. code:: bash
199+
200+
cd hardware\esp8266com\esp8266
201+
git status
202+
git pull

0 commit comments

Comments
 (0)