A good structure of a README file

Jump to bottom

Dmitri edited this page Feb 7, 2021 · 2 revisions

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

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