Project Title

Inspired by the blog post at http://blog.thefrontiergroup.com.au/2013/05/writing-a-good-readme/

General Information

Client Contact Details and 3rd Party Vendors

Names of Developers

Outline Technologies, Eg frameworks, programming language

Links to related Projects

Links to online tools related to the application, e.g. Dropbox (including folders), Basecamp, etc

Getting Started

How to install and setup the app/site

Instructions on running the app, e.g. for rails, make sure run rake db migrate and rake db seed, starting server, pow, etc

Testing

Include commands to run for testing

Staging and Production Environments

Which server is the application on

How to connect to the server

Where on the server the application is located

Deploy process

Any other services on the box related to the app, e.g. cron, resque, sidekiq