Blog Logo

Guide to writing on for GitHub project

A README is a text file that introduces and explains a project. It is commonly required to understand what the project is about. GitHubs default readme file contains the repository name and some basic instructions. Markdown (.md file) is a lightweight markup language that can be easily converted to text and is the standard format for ReadMe files in Git. A well-written readme file is important for open-source projects as it helps explain what is uploaded and how to use it. It even allows the uploader to add images and videos to help the reader navigate through the project. It is also essential for future reference as it helps you understand the code better. To create a repository, follow these steps: Log in to GitHub, Click on + icon, select New Repository, enter the username of your GitHub account and check the Add a README file checkbox.