Jul 13, 2020
How To Create A GitHub Profile README
Hello everyone!
GitHub recently released a feature that allows users to create a profile-level README to display prominently on their GitHub profile.
README Files
A README file, along with a repository license, contribution guidelines, and a code of conduct, helps you communicate expectations for and manage contributions to your project.
The GitHub profile-level README feature allows more content than the profile bio, supports markdown which means you can play around with the content more visually and the README is significantly more visible as it is placed above-pinned repositories and takes up as much space above the fold of the webpage as you like.
A solid README is a core-component of well-documented software and often encourages collaboration by sharing helpful context with contributors. In my opinion, a profile-level README seems like a great extension of a convention a lot of GitHub users are already familiar with.
How do I create a profile README?
Steps to begin:
- The profile README is created by creating a new repository that’s the same name as your username. For example, my GitHub username is akanksha-raghav so I created a new repository with the name akanksha-raghav.
Do check the cool message that “You have found a secret! It is a special repository
NOTE: As I have already created the repo hence it's showing
“The repo already exists”
2. Create a README.md file inside the repo with text, images, emojis, etc.
For exploring Markdown Syntax: https://guides.github.com/pdfs/markdown-cheatsheet-online.pdf
3. Commit your new README and yes you are done!
Note: At the time of this writing, in order to access the profile README feature, the letter-casing must match your GitHub username.
Congratulations!! you have created a solid README for your Github.
