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

update misc docs + copy #26

Merged
merged 3 commits into from
Jul 19, 2016
Merged

update misc docs + copy #26

merged 3 commits into from
Jul 19, 2016

Conversation

lacker
Copy link
Contributor

@lacker lacker commented Jul 19, 2016

I updated some of the documentation and some of the messages the tool prints out. I think this makes things more clear but I welcome feedback.

  • I mentioned that images and css get bundled too, in the readme
  • I added a brief list of the features this supports. Wasn't obvious to me before that e.g. autoprefixing was happening. I think this includes the reasonable ones
  • The cd command printed out was wrong before if you were building somewhere other than cwd
  • Now there is one intermediate message while doing the npm installs and it gives the approximate time (a couple minutes)

@ghost ghost added the CLA Signed label Jul 19, 2016
@@ -19,11 +19,18 @@ npm install -g create-react-app

**You’ll need to have Node >= 4 on your machine**. We recommend to use Node >= 6 and npm >= 3 for faster installation speed and better disk usage. You can use [n](https://github.com/creationix/nvm#usage) to easily switch the Node versions between different projects.

**This tool doesn’t assume a Node backend**. The Node installation is only required for the build tools that rely on it locally, such as Webpack and Babel. The output folder includes an `index.html` and a minified `.js` bundle so you can host them anywhere you like.
**This tool doesn’t assume a Node backend**. The Node installation is only required for the build tools that rely on it locally, such as Webpack and Babel. The output folder includes an `index.html`, a minified `.js` bundle, and bundled images and css, so you can host them anywhere you like.
Copy link
Contributor

Choose a reason for hiding this comment

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

To be fair, we don’t really provide CSS files, they are embedded in JS. Maybe that’s an implementation detail. (Or maybe we should extract them.)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Honestly I don't actually understand what the webpack black magic is doing here. ;-) To my noobish mind, it's "sticking the css into the bundle". I'm happy to go with any alternate wording, as long as we do mention that this bundling does something with css, or we can just leave it as "implementation detail".

@gaearon
Copy link
Contributor

gaearon commented Jul 19, 2016

👍 with a few nits

@lacker lacker merged commit b8a2b98 into facebook:master Jul 19, 2016
@lock lock bot locked and limited conversation to collaborators Jan 22, 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.

3 participants