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

Conversation

Projects
None yet
5 participants
@shaunwallace
Copy link
Contributor

commented Apr 4, 2017

  • 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).

This comment has been minimized.

Copy link
@gaearon

gaearon Apr 4, 2017

Member

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 ..."

This comment has been minimized.

Copy link
@shaunwallace

shaunwallace Apr 4, 2017

Author Contributor

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

This comment has been minimized.

Copy link
Collaborator

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

This comment has been minimized.

Copy link
Contributor Author

commented Apr 4, 2017

@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

This comment has been minimized.

Copy link
Member

commented Jun 27, 2017

Thanks!

@gaearon gaearon merged commit 4edec9e into facebook:master Jun 27, 2017

0 of 2 checks passed

continuous-integration/appveyor/pr Waiting for AppVeyor build to complete
Details
continuous-integration/travis-ci/pr The Travis CI build is in progress
Details

kellyrmilligan added a commit to kellyrmilligan/create-react-app that referenced this pull request Jun 28, 2017

Merge branch 'master' into serve-app-under
* master: (59 commits)
  Better React Native Web support (facebook#2511)
  Bump dependencies (facebook#2658)
  Minor code style edits to user guide (facebook#2660)
  Don't ask to install webpack for using Styleguidist (facebook#2656)
  Put react-scripts in dependencies, not devDependencies (facebook#2657)
  Razzle added to the alternatives (facebook#2517)
  Warn about large bundle sizes (facebook#2648)
  Add instructions to use source-map-explorer (facebook#1641)
  Ignore "Skipping static resource" message from SW precache (facebook#2645)
  Add React Styleguidist (facebook#2044)
  Update ISSUE_TEMPLATE.md (facebook#2643)
  Add Brackets to launchEditor.js (facebook#2637)
  Updated README (facebook#1931)
  Less passive-aggressive issue template
  Added instruction on how to install Prettier (facebook#2006)
  Fix CLI grammar (facebook#1945)
  Update README.md (facebook#1813)
  Add more info about OOM build failiure [docs] (facebook#2060)
  Update docs with WebSocket proxy information (facebook#2305)
  Add yarn example under "Installing a Dependency" (facebook#2362)
  ...

@gaearon gaearon referenced this pull request Jun 28, 2017

Merged

Changelog for 1.0.8 #2664

romaindso added a commit to romaindso/create-react-app that referenced this pull request Jul 10, 2017

Updated README (facebook#1931)
* 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 added a commit to BrickworkSoftware/create-react-app that referenced this pull request Sep 1, 2017

Updated README (facebook#1931)
* 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.
You can’t perform that action at this time.