Skip to content
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

Updated README #1931

Merged
merged 5 commits into from
Jun 27, 2017
Merged

Updated README #1931

merged 5 commits into from
Jun 27, 2017

Conversation

shaunwallace
Copy link
Contributor

  • Updated README.md to note nvm support on windows and link to nvm docs on alternatives.

  • Added tree structure for better visual representation of the initial project output.

README.md Outdated
@@ -44,6 +44,8 @@ npm install -g create-react-app

**We strongly recommend to use Node >= 6 and npm >= 3 for faster installation speed and better disk usage.** You can use [nvm](https://github.com/creationix/nvm#usage) to easily switch Node versions between different projects.

**Note:** `nvm` does not support Windows (nvm issue [#284](https://github.com/creationix/nvm/issues/284)). See potential [alternatives](https://github.com/creationix/nvm#installation).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you embed this into previous sentence please? It's not super essential and I don't want to clobber up the page. For example "you can use nvm or alternatives to ..."

Copy link
Contributor Author

@shaunwallace shaunwallace Apr 4, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What if I remove the note on support for Windows users and rather update the link for nvm to direct users to the installation section of the docs which explains its compatibility. The reason I added the note is that the link to nvm takes the user to the usage section which doesn't quickly let the user see that they may not be able to use this for node management.

@Timer
Copy link
Contributor

Timer commented Apr 4, 2017

This is a fly-by but nvm is very heavy weight on your shell and increases shell startup time (on macOS), maybe we should consider recommending n instead.

@shaunwallace
Copy link
Contributor Author

@Timer ya that might be something we can open up in a separate discussion to have more thoughts on the which tool is suggested by cra. Either tool unfortunately doesn't support Windows users and my opinion is that we should at least make that transparent if suggesting tools.

@gaearon gaearon added this to the 1.0.8 milestone Jun 27, 2017
@gaearon
Copy link
Contributor

gaearon commented Jun 27, 2017

Thanks!

@gaearon gaearon merged commit 4edec9e into facebook:master Jun 27, 2017
@gaearon gaearon mentioned this pull request Jun 28, 2017
romaindso pushed a commit to romaindso/create-react-app that referenced this pull request Jul 10, 2017
* adding comment on windows support of nvm

* adding tree structure for intial project output

* applying feedback from this thread create-react-app/pull/1931
morgs32 pushed a commit to BrickworkSoftware/create-react-app that referenced this pull request Sep 1, 2017
* adding comment on windows support of nvm

* adding tree structure for intial project output

* applying feedback from this thread create-react-app/pull/1931
@lock lock bot locked and limited conversation to collaborators Jan 21, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants