A README is a markdown file in a Github repository to let others know the scope and other details of the project. Some things included in a readme file are — contribution guidelines, code of conduct, working of the project, etc.

Generating README files automatically.

There is a handy tool called readme.so that can help you create and customize your READMEs easily. It is a simple editor wherein you simply need to click on a section to edit the content, and the section gets added to your readme.

Creating a profile-level README

You can also customize your GitHub profile page to include information that you would like to showcase. The Github profile Readme is a public repository containing a README.md file and appears at the top of your profile page. All the content you want to showcase on your Github page should be included in this README.md file. However, there are few points to keep in mind:

  • The name of the repository should match your GitHub username. For example, if your username is octo, the repository name must be octo.
  • The repository should be public.
  • There should be a README.md file in the root of the repository, and it should be populated with some content.

Check out matiassingers/awesome-readme for inspiration on some cool READMEs.

Continue reading: https://towardsdatascience.com/a-tour-of-10-useful-github-features-d92dde0bf412?source=rss—-7f60cf5620c9—4

Source: towardsdatascience.com