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.

Sign up for GitHub

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

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bcc604d
adding comment on windows support of nvm
swallace Apr 4, 2017
f397890
adding tree structure for intial project output
swallace Apr 4, 2017
474c56d
Merge branch 'master' into updatedReadme
shaunwallace Apr 4, 2017
87674ea
applying feedback from this thread create-react-app/pull/1931
swallace Apr 7, 2017
028aed9
Merge branch 'master' into updatedReadme
gaearon Jun 27, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 17 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 •
edited
Loading

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.


**This tool doesn’t assume a Node backend**. The Node installation is only required for Create React App itself.

### Creating an App
Expand All @@ -59,21 +61,21 @@ It will create a directory called `my-app` inside the current folder.<br>
Inside that directory, it will generate the initial project structure and install the transitive dependencies:

```
my-app/
README.md
node_modules/
package.json
.gitignore
public/
favicon.ico
index.html
src/
App.css
App.js
App.test.js
index.css
index.js
logo.svg
my-app
├── README.md
├── node_modules
├── package.json
├── .gitignore
├── public
│ └── favicon.ico
│ └── index.html
└── src
└── App.css
└── App.js
└── App.test.js
└── index.css
└── index.js
└── logo.svg
```

No configuration or complicated folder structures, just the files you need to build your app.<br>
Expand Down