Improve README - Githubissues

forumone / generator-web-starter

Yeoman generator for the Web Starter Kit

https://www.npmjs.com/package/generator-web-starter

MIT License

8 stars 5 forks source link

Improve README #12

Open azinck opened 9 years ago

azinck commented 9 years ago

I didn't find the README very clear or helpful in getting going with this. Here are some specific questions I had: https://www.dropbox.com/s/waar2aknkbjtvcr/Screenshot%202015-07-15%2013.20.08.png?dl=0

I'd also suggest some documentation on how to update existing web-starter projects using the generator since that's apparently a goal of this work.

slucero commented 9 years ago

Potential section headings (Related tickets for reference in parenthesis):

Project goals and features (#15 & #16)
Installation (#14)
General usage (#15 & #16)
Support and contribution (#17 & #18)

I expect that each section in the readme should probably be limited to a high-level overview of each topic with guidance to more comprehensive documentation on each topic to be generated in the related issues.