Add Getting Started page #2487
Merged
Add Getting Started page #2487
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
marcelstoer
force-pushed
the
feat/doc-quickstart
branch
from
18a3efb
to
dd772d7
Compare
TerryE
requested changes
Sep 17, 2018
docs/en/getting-started.md
Outdated
|
|
||
| **How to read this** | ||
|
|
||
| Use case: you're just starting with NodeMCU and your OS of choice is Windows (and you save using LFS for later). The blue boxes in the 'Windows' column are your guideline. You: |
There was a problem hiding this comment.
(and you ... The blue reads better as
(and you are not using LFS), then the blue
docs/en/getting-started.md
Outdated
|
|
||
| ## Cloud Builder | ||
|
|
||
| The cloud builder at [https://nodemcu-build.com](https://nodemcu-build.com) allows to pick NodeMCU branch, modules and a few other config options (e.g. SSL yes/no). After the build is completed you will receive an email with two links to download your custom firmware: |
There was a problem hiding this comment.
... configuration options ...
docs/en/getting-started.md
Outdated
|
|
||
| ## Docker | ||
|
|
||
| The [Docker NodeMCU build image](https://github.com/marcelstoer/docker-nodemcu-build) is the easiest method to build NodeMCU related artifacts locally on your preferred platform. |
There was a problem hiding this comment.
"artifacts" isn't the best noun here. How about components?
docs/en/getting-started.md
Outdated
|
|
||
| [↑ back to matrix](#task-os-selector) | ||
|
|
||
| _Note that this image is not an official NodeMCU offering. It's maintained by a NodeMCU team member as an individual, though._ |
docs/en/getting-started.md
Outdated
| A local copy of `luac.cross` is only needed if you want to compile the Lua files into an LFS image yourself and you are _not_ using Docker. | ||
|
|
||
| ### Windows | ||
| Windows 10 users can install and use the Windows Subsystem for Linux (WSL). Alternatively all Windows users can [install Cygwin](https://www.cygwin.com/install.html). (You will only need the Cygwin core). Either way, you will need a copy of the `luac.cross` compiler: |
There was a problem hiding this comment.
... (You will only need the Cygwin core + gcc-core + gnu make options during setup). ...
docs/en/getting-started.md
Outdated
| Windows 10 users can install and use the Windows Subsystem for Linux (WSL). Alternatively all Windows users can [install Cygwin](https://www.cygwin.com/install.html). (You will only need the Cygwin core). Either way, you will need a copy of the `luac.cross` compiler: | ||
|
|
||
| - You can either download this from Terry's fileserver. The [ELF variant](http://files.ellisons.org.uk/esp8266/luac.cross) is used for all recent Linux and WSL flavours, or the [cygwin binary](http://files.ellisons.org.uk/esp8266/luac.cross.cygwin)) for the Cygwin environment. | ||
| - Or you can compile it yourself by downloading the current NodeMCU sources (this [ZIPfile](https://github.com/nodemcu/nodemcu-firmware/archive/master.zip)); edit the `app/includes/user_config.h` file and then `cd` to the `app/lua/luac_cross` and run make to build the compiler in the NodeMCU firmware root directory. Note that the `luac.cross` make only needs the host toolchain which is installed by default in WSL, but in Cygwin you will need to tick the _gcc-core_ + _gnu make_ options during setup. |
|
Thank you Terry for the detailed feedback! |
|
@marcelstoer Marcel, 👍 to the updates. The others have now had a couple of days to give feedback, so I suspect that we have had all of the review comments that we are going to get, and I will merge this now. Feel free to ripple this over to master. Thanks, this is a valuable addition to the doc set. |
TerryE
approved these changes
Sep 17, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #2481, #2431
As discussed earlier in several other issues. Ideally this should land rather quickly and then immediately be pulled over to master to fill the (LFS) documentation gaps.