yesodweb / yesod-scaffold

The Yesod scaffolding, with branches for different versions.
MIT License
76 stars 39 forks source link

Add README to scaffolded project #169

Closed MaxGabriel closed 6 years ago

MaxGabriel commented 6 years ago

Addresses part of #137

I think a README would be a really good addition to the scaffolded project. It would help new users get started, and provide a foundation of documentation for adding other people to your project. IIRC, generating a README is pretty standard other scaffoldings I've seen.

Suggested additions or changes to this README are welcome.

The only potential hassle here is providing database-specific setup instructions.

snoyberg commented 6 years ago

Thanks!