Add README to scaffolded project #169
Conversation
[ci skip]
| Start a development server with: | ||
|
|
||
| ``` | ||
| stack exec -- yesod devel |
There was a problem hiding this comment.
Should probably command on needing to run stack build yesod-bin first.
There was a problem hiding this comment.
So that's covered in the Quick Start guide, but I think it would be good to pull the stuff from the QuickStart guide into this README (the quickstart guide hasn't changed that much since the transition to Stack).
The Quickstart guide recommends this command:
stack build yesod-bin cabal-install --install-ghc
Do you know offhand if cabal-install is actually necessary?
There was a problem hiding this comment.
cabal-install is no longer necessary, we can remove that recommendation.
There was a problem hiding this comment.
Nice, saw you removed it from the quickstart guide as well 👍
README.md
Outdated
| stack test --flag PROJECTNAME_LOWER:library-only --flag PROJECTNAME_LOWER:dev | ||
| ``` | ||
|
|
||
| (Because `yesod devel` passes the `library-only` and `dev` flags, matching those flags means you don't need to recompile between tests and development, and it disables optimization to speed up your tests). |
There was a problem hiding this comment.
@snoyberg Is there a way Stack can default stack test to use these flags, so they don't need to be specified on the command line?
There was a problem hiding this comment.
Unfortunately not. A somewhat funny approach we could consider is adding a Makefile with targets like devel and test. I've seen a number of people doing this recently.
There was a problem hiding this comment.
Hm ok, something to consider then
|
Thanks! |
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.