README

  • Ruby version

  • System dependencies

  • Configuration: Create a config/application.yml file using config/application.example.yml as a guide

  • Database creation

  • Database initialization

  • How to run the test suite

  • Services (job queues, cache servers, search engines, etc.)

  • Deployment instructions

Please feel free to use a different markup language if you do not plan to run rake doc:app.