Skip to content

Update the documentation with clearer paths and info on sub-modules #5816

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

Closed
wants to merge 2 commits into from
Closed

Update the documentation with clearer paths and info on sub-modules #5816

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1854c30
Update the documentation with clearer paths and info on sub-modules
scottchiefbaker Feb 24, 2019
136663a
Fix a path because we had already CDd in to the parent dir
scottchiefbaker Feb 25, 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
27 changes: 16 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,29 +42,34 @@ Documentation: [https://arduino-esp8266.readthedocs.io/en/2.5.0/](https://arduin
[![Linux build status](https://travis-ci.org/esp8266/Arduino.svg)](https://travis-ci.org/esp8266/Arduino)

- Install the current upstream Arduino IDE at the 1.8 level or later. The current version is at the [Arduino website](http://www.arduino.cc/en/main/software).
- Go to Arduino directory
- Go to your Arduino sketchbook directory
- For Mac OS X, it is `Arduino.app` showing as the Arduino icon.
This location may be your `~/Downloads`, `~/Desktop` or even `/Applications`.
```bash
cd <application-directory>/Arduino.app/Contents/Java
```
- For Linux, it is ~/arduino by default.
- For Linux, it is `~/arduino/` by default.
```bash
cd ~arduino
cd ~/arduino/
```
- Clone this repository into hardware/esp8266com/esp8266 directory (or clone it elsewhere and create a symlink)

- Clone this repository into `hardware/esp8266com/esp8266/` (or clone it elsewhere and create a symlink)
```bash
cd hardware
mkdir esp8266com
cd esp8266com
git clone https://github.com/esp8266/Arduino.git esp8266
git clone https://github.com/esp8266/Arduino.git hardware/esp8266com/esp8266/
```
- Download binary tools (you need Python 2.7)

- This repo requires other tools (sub-modules) that we need to fetch
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we don't need that in the documentation
There's currently only one sub-sub-module tools/sdk/lwip2/builder/lwip2-src/ which is not necessary, because it is precompiled (in tools/sdk/lib/).

Or you could state:

Sub-sub modules are not necessary for a fully running repository. However they can be downloaded with the following command:

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To get a functioning toolchain you 100% need the submodules. You don't get pyserial or esptool without fetching the submodules.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am talking about sub-sub-modules

#5882 (comment)

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where are you seeing a reference to sub-sub-modules in the README?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

git clone --recursive takes everything, we only need one level

git clone ...
cd <dir>
git submodule update --init

git clone --recursive is the equivalent of

git clone ...
cd <dir>
git submodule update --init --recursive

check #5882 which is merged now

```bash
cd hardware/esp8266com/esp8266/
git submodule update --init --recursive
```

- Download binary tools (requires Python 2.7)
```bash
cd esp8266/tools
cd tools/
python get.py
```
- Restart Arduino
- Restart the Arduino IDE
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would note that opening the boards manager (and letting it download indexes?) gives me the same effect as restarting the IDE (on Windows 10 at least). Same with library manager for libraries.
Seems to force Arduino to do a re-scan of directories.


### Using PlatformIO

Expand Down