Tidy up Readme's - Githubissues

merkle-open / generator-nitro

Your frontend? Fuel it with Nitro! Develop your frontend with a proven but flexible Node.js app, even in a large team.

MIT License

71 stars 28 forks source link

Tidy up Readme's #16

Closed brunschgi closed 9 years ago

brunschgi commented 9 years ago

At the moment there are 2 Readme's:

/README.md
/app/templates/README.md

All of the application relevant stuff should be moved to /app/templates/README.md. The global README should only contain generator stuff.

ernscht commented 9 years ago

I suggest using /app/templates/README.md for the main description of the project ( maybe like the example on github: https://github.com/namics/frontend-defaults/blob/master/doc/README.md ) – and to move the application usage README to /app/templates/project/docs/NITRO_README.md

/README.md (Generator README)
/app/templates/README.md (Main README for the project)
/app/templates/project/docs/NITRO_README.md (Nitro README)

Update

app/USAGE

deniaz commented 9 years ago

I've split the information according to @ernscht's comment:

/README.md: Generator information, see here
/app/templates/README.md: adapted README template (translated from frontend-defaults), see here
/app/templates/USAGE.md: Information on how to use yo generators, gulp tasks and on how to customize a Nitro app, see here

Thoughts?