Update the documentation with clearer paths and info on sub-modules #5816
Conversation
|
This should clear up some confusion that caused me to open #5804 |
| python get.py | ||
| ``` | ||
| - Restart Arduino | ||
| - Restart the Arduino IDE |
There was a problem hiding this comment.
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.
| ``` | ||
| - Download binary tools (you need Python 2.7) | ||
|
|
||
| - This repo requires other tools (sub-modules) that we need to fetch |
There was a problem hiding this comment.
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:
There was a problem hiding this comment.
To get a functioning toolchain you 100% need the submodules. You don't get pyserial or esptool without fetching the submodules.
There was a problem hiding this comment.
I am talking about sub-sub-modules
There was a problem hiding this comment.
Where are you seeing a reference to sub-sub-modules in the README?
There was a problem hiding this comment.
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
|
@scottchiefbaker If you don't agree with current master can you fix this PR (or close and make another one) ? |
earlephilhower
added
the
merge-conflict
No description provided.