-
Notifications
You must be signed in to change notification settings - Fork 3.1k
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.
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
Wording for README.md #2418
Comments
Fine for me, I like. Two issues:
How about
-> maybe mention something about the respective NodeMCU branches? |
Good points which is why I felt that issue would be more appropriate now. I must admit that I tend to use ESP module as a short hand. Your list is specific: maybe we should just use it to introduce the defined term (ESP Module). I agree that we should discuss the branches, at least |
It would be helpful to add the release version (eg. 2,2,0-master_20180608) to the title of the README title. I have several versions of NodeMCU, and it's tedious to have to check the source directory to find out which version's documentation I've found. Will |
@cwrseck. I can't follow your logic here. The README is in the source directory. How do you do your build? Via cloud builder or what? From our PoV, having the version in the README is a PITA as you now have to update this file every release. |
I have a docs link on the desktop, effectively (I'm building NodeMCU from a local directory). With various versions in play, it's handy to know which version of the docs goes with which without scuffling through the file system. In general I'd expect the version number to be updated automatically when each new release is built, but there may well be difficulties I'm not aware of. Will |
Surely, if you are building NodeMCU locally then you are surely running a Linux dev system, in which case it's only going to be a few line script in an alias or |
Ready for PR IMHO. |
Fixed in 8505362 |
Another issue that doesn't fit the templates. This is a trivial one but worth discussing and reaching consensus before raising the PR. There are a could of issues with the project README that deserve fixing. (Many thanks to @nailujx86 for raising this).
The text was updated successfully, but these errors were encountered: