ReadMeFiles
Maybe read the README file for this site?
Template for Writing Them (by Bitbucket)
Bitbucket, who hosts the repo for this site, lets you quickly create a README.md file through their interface. Usually that's NoBigDeal, but upon making one you're presented with an actually really helpful template/boilerplate for a README! See it below.
# README #
This README would normally document whatever steps are necessary to get your application up and running.
### What is this repository for? ###
* Quick summary
* Version
* [Learn Markdown](https://bitbucket.org/tutorials/markdowndemo)
### How do I get set up? ###
* Summary of set up
* Configuration
* Dependencies
* Database configuration
* How to run tests
* Deployment instructions
### Contribution guidelines ###
* Writing tests
* Code review
* Other guidelines
### Who do I talk to? ###
* Repo owner or admin
* Other community or team contact