Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.Sign up
fool-proofing the generated README.md #1768
This is more or less what we now use as a readme-starting-point. I thought I'd share it with you.
We also usually have more prerequisites up there (usually ruby + bundler). Other than that, i merely used more levels of headlines and added a section for deployment. The intention is to enable any developer to clone, use, test and deploy the resulting codebase.