Add README to generated project.

[eanplatter]

Fixes#29

[eanplatter]

I wanted to get some feedback on where we wanted to keep a README for the project itself.

I assume we don't want to just copy over the README from create-react-app but rather a README that takes the user's app name and just lists out some basic getting started instructions.

I was going to put it in the ./src but we're copying all of those files into the ./src of the project, so I'd have to end up checking for it and omitting it.

Any thoughts?

[gaearon]

Yeah, let's do a separate directory for host setup, and put another README there that is more practical (basically a howto document).

[eanplatter]

Would it make sense to have all of the code that will be put into the user's project in one place?

So instead of the following being in the root of the library:

+-- injectedREADME.md
+-- index.html
+-- src
| +-- App.js
| +-- App.css
| +-- ...

You have something more like this:

+-- hostFiles
| +-- index.html
| +-- README.me
| +--src
| | +-- App.js
| | +-- App.css
| | +-- ...

That way when we're creating the user's files the method would be simpler, we can just forEach through the hostFiles and map it out into the user's project.

[vjeux]

Sounds like a good idea to me

[eanplatter]

ok, I'm working on a hostFiles setup right now, I'll send it up to this PR shortly!

[eanplatter]

Just as with the src directory, all of the files within the templateFiles directory will be put into the root of the project.

[eanplatter]

Hey @gaearon any idea why this travis test is failing on node 4 but not 6?

[gaearon]

This is intentional, I’m fixing e2e script to check for failure occurring in #31.
The issue will be fixed by #36 but I want to make sure our e2e test catches such errors.

[eanplatter]

Cool, should I hold off merging until this is fixed?

[gaearon]

Please do, I’m almost finished there.

[eanplatter]

No prob!

[gaearon]

You’re good to go now, sorry for the interruption!

[eanplatter]

Cool thanks, rebuilding now. I think this PR is to be reviewed

[gaearon]

What do you think about moving src itself to templateFiles?
Also I’d prefer template to templateFiles.

[eanplatter]

yeah I guess the template directory would be a good place for it, essentially a mirror of the default user app.

[gaearon]

If you go that way you’ll need to look for var relative = and adjust those paths.

[eanplatter]

kk, thanks for the tip. I'll hop on this later today after work.

[eanplatter]

So now when a user runs npm run create-react-app myApp they get a file structure that looks like this:

[eanplatter]

@gaearon sorry this took so long! I think it's ready now.

[gaearon]

you probably don't want this log 😉

[gaearon]

Thanks!

[eanplatter]

Thanks for putting up with me :)