How To Make a README

How To Make a README

A README is a text file that introduces and explains a project. It contains information that is commonly required to understand what the project is about. It allows other programmers the necessary instructions to properly utilize your application. Another great thing about README is that it is highly effective in the world of open source development, allowing developers to make contributions the right way to a specific project.

Another important aspect of README's is that code hosting services such as GitHub, Bitbucket, and GitLab will also look for your README in order to display it along with the list of files and directories in your project.

A popular way to write a README is in a lightweight format called Markdown which is just a simple way to create that nice uniform formatting on your device I was speaking of earlier allowing you to manipulate the text.

Some programmers are not use to the formatting protocols of markdown but there are tools you can use to help you create a beautiful markdown without all of the learning curves. One that has popped up as of recent is README.SO

Screen Shot 2021-06-24 at 1.22.58 PM.png

README.SO provides a great launching pad so you can focus on what you do best which is code wonderful applications at scale.

Give it a try!