esp*/README.md: Updates and clarifications. #5713
Conversation
|
This comes up on the forum/irc/slack often enough that I thought it was worthwhile fixing the docs. |
ports/esp32/README.md
Outdated
| $ ./install.sh # (or install.bat on Windows) | ||
| ``` | ||
|
|
||
| Then the `ports/esp32` directory, source the `export.sh` script to set up the |
There was a problem hiding this comment.
"The the"?
Also, I'm not following, why does one need to run export.sh from within the ports/esp32 directory?
There was a problem hiding this comment.
You source it, not run it. It sets PATH.
But you're right of course that it can be run from anywhere. Have clarified this slightly.
ports/esp32/README.md
Outdated
| SPIRAM, but prefer to use a specific board target (or define your own as | ||
| necessary). | ||
|
|
||
| Note the use of `?=` in the `makefile` which allows them to be overriden on |
Also fix Espressif links to the specific version they apply to.
|
|
||
| - Use a Docker image with a pre-built toolchain (**recommended**). | ||
| To use this, install Docker, then prepend | ||
| `docker run --rm -v $HOME:$HOME -u $UID -w $PWD larsks/esp-open-sdk ` to the start |
There was a problem hiding this comment.
I'd suggest really spelling this out step by step for newer users.
(you'd think newer users wouldn't be trying to build from scratch, but a surprising number of people do)
There was a problem hiding this comment.
OK, will do.
Yes it's really useful for people who want to freeze modules, so definitely worth spelling it out in detail.
There was a problem hiding this comment.
this was left as-is; please open a new PR for additional changes (if any)
There was a problem hiding this comment.
Yes, please - more detail here would be very helpful. It seems like several steps are skipped here.
| @@ -146,7 +165,7 @@ Documentation | |||
| ------------- | |||
|
|
|||
| More detailed documentation and instructions can be found at | |||
| http://docs.micropython.org/en/latest/esp8266/ , which includes Quick | |||
| http://docs.micropython.org/en/latest/esp8266/, which includes Quick | |||
There was a problem hiding this comment.
Isn't the space necessary to prevent markdown from including the , in the URL?
There was a problem hiding this comment.
Ah makes sense. Will fix. Thanks
Mostly around obtaining and using the toolchain