8000 Add fix for SoftwareSerial submodule errors to documentation by phrxmd · Pull Request #5602 · esp8266/Arduino · GitHub
[go: up one dir, main page]
Skip to content

Add fix for SoftwareSerial submodule errors to documentation #5602

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 18, 2019
Merged

Add fix for SoftwareSerial submodule errors to documentation #5602

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
60d6ed5
Add fix for SoftwareSerial submodule errors to documentation
Jan 8, 2019
e0bc4c8
Update installing.rst
devyte Jan 18, 2019
a44d92c
Merge branch 'master' into master
devyte Jan 18, 2019
7e8fbeb
Update installing.rst
devyte Jan 18, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update installing.rst 
Replaces and based on #5602
Fixes #5583
  • Loading branch information
@devyte
devyte authored Jan 18, 2019
commit e0bc4c822d9d959fb8e9efac75afa4af97cef575
28 changes: 18 additions & 10 deletions doc/installing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,15 @@ Instructions - Windows 10
--- boards.txt
--- LICENSE

- Initialize the submodules

.. code:: bash

cd %USERPROFILE%\Documents\hardware\esp8266com\esp8266
git submodules update --init

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.

- Download binary tools

.. code:: bash
Expand All @@ -112,16 +121,6 @@ Instructions - Windows 10

- If using the Arduino IDE for Visual Studio (https://www.visualmicro.com/), be sure to click Tools - Visual Micro - Rescan Toolchains and Libraries

- You may see some error messages about missing files related to the
``SoftwareSerial`` library. These are because the ESP8266 version
of this library has been moved to a separate git submodule. In
order to get rid of these messages, initialize the submodule:

.. code:: bash

cd %USERPROFILE%\Documents\hardware\esp8266com\esp8266
git submodules update --init

- When later updating your local library, goto the esp8266 directory and do a git pull

.. code:: bash
< 6D98 svg aria-hidden="true" height="16" viewBox="0 0 16 16" version="1.1" width="16" data-view-component="true" class="octicon octicon-fold-down"> Expand Down Expand Up @@ -176,6 +175,15 @@ Instructions - Other OS
--- boards.txt
--- LICENSE

- Initialize the submodules

.. code:: bash

cd esp8266
git submodules update --init

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.

- Download binary tools

.. code:: bash
Expand Down
0