Why: Onboarding new developers Remembering how to continue work on the project yourself
What to include: - Who has contributed, their contact details, etc - What dependencies the project has, e.g. imagemagick, postgres, etc - How to get the project bootstrapped and ready for development locally - How to deploy the project into production - Running tests - Third party services - How to contribute/features (this probably should belong in a different file) - Build status etc - Overview of the project, what is trying to achieve, etc.
How to get started?
- Use a service such as http://readme.io/
- Check out what some large OSS projects you use do
- Always think that someone else will have to use and setup your project (even yourself much much later on)
Summary - Good readme docs save your sanity - Always think like someone else will have to take over or contribute to the project - It does not have to be perfect, it can be updated