Writing Awesome READMEs
This article will explore possible items to include your Git repo README file. We will discuss several items that we can include in a README and when to include them. What is a README? A README file is a text file that explains a project to new user. It helps users quickly understand where to find information on the project such as brief description of your project, how to install/fork it and/or how to use your code. READMEs live in the top level directory of your repo in GitHub, Bitbucket or GitLab. ...