📔

Readme on Github

Created
Aug 1, 2022 3:51 AM
Department
Engineering
Category
Well Documented
Technology
Git
Tags
Date
August 1, 2022
URL

All repositories should have a very well documented readme which provides the following information to the reader -

  • A brief idea of the project along with relevant links
  • Tech stack used
  • System requirements
  • Third-party dependencies or services used
  • Deployment options
  • Credentials required to run the project
  • Environment variables required

An example of a readme in adherence to this format can be found in the readme.md file of this project here.