Skip to content

ruby-stars/housemate

Repository files navigation

README

##Housemate

Housemate aims to make it easier for people living in shared places, may it be a house, a flat or a houseboat ;) to organize their day to day life. Housemates can set up groups for specific purposes, e.g. a gardening group consisting of people taking care of the shared garden. Within these groups they can plan tasks, e.g. planting the carrots.

This README would normally document whatever steps are necessary to get the application up and running.

Things you may want to cover:

  • Ruby version

  • System dependencies

  • Configuration

  • Database creation

  • Database initialization

  • How to run the test suite

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

  • Deployment instructions

  • ...