Readme File Updates #171
Readme File Updates #171
Conversation
gaboesquivel
commented
May 10, 2018
•
gaboesquivel
commented
- add a table of contents to readme file using doctoc.
- update and rearrange readme file contents for a better organization.
|
This looks good to me, although I feel like someone else should look at the documentation changes before approving. Can you take a look @micahalcorn ? |
.node-version
Outdated
| @@ -0,0 +1 @@ | |||
| v9.11.1 | |||
There was a problem hiding this comment.
Is this something that can go in package.json instead? I think we should avoid too many dotfiles unless absolutely necessary
There was a problem hiding this comment.
And is 9.11.1 the appropriate number? I think I'm still running 8.5.0 just fine.
There was a problem hiding this comment.
Yeah, and right now we're not even instructing users to use nvm. I'll mention that there is an engines section in package.json, but this is not enforced unless the user has set their own engine-strict flag, which is false by default.
There was a problem hiding this comment.
@tyleryasaka I actually use n when I'm not using rvm. 😂
There was a problem hiding this comment.
Hey @nick, there's only one project that does automatic node version switching based on engines from package.json Kikobeats/nodengine , but it doesn't really work well. avn can be used with both nvm and n. AVN works with .node-version wbyoung/avn
There was a problem hiding this comment.
sure, I will remove it. I do find it very useful though. If you are working on different projects and contributing to different open source packages, automatic node version switching is great, that way you just cd the project dir and boom! you get the right version, no need to read each project's readme file and manually change it.
There was a problem hiding this comment.
Just FYI, they are still working reading from engines.node of the package.json nvm-sh/nvm#1535. N efforts to support this feature are staled tj/n#192. That's why the .node-version files is still required. weird right, not sure why it's taking so long. ¯_(ツ)_/¯
There was a problem hiding this comment.
Thanks. You can always use .node-version in your own environment by adding to .git/info/exclude
There was a problem hiding this comment.
yeah. just found another package that's handy too.
https://www.npmjs.com/package/check-engine
➜ origin-js git:(develop) check-engine
Checking versions...
✘ node version is incorrect! Expected 9.11.1 but was v8.9.3.
Environment is invalid!
|
I like the TOC but I think @wanderingstan needs to be the one to review the copy edits. |
quick fix of some things that immediately caught my eye
|
@gaboesquivel thanks for this. There's an ongoing effort to improve the readmes and this is a big step forward. Give me a little while to ensure that all the things promised here are actually true. (E.g. the raw js |
gaboesquivel
changed the title
|
This is not longer mergeable due to conflicts with 6537a97 I can incorporate those changes to this PR if necessary.
|
|
Closing as this is appears stale. Fee free to reopen. |
