
The repository name no longer matches your username.The README file is empty or doesn't exist.The profile README is removed from your GitHub profile if any of the following apply: The generated README file is pre-populated with a template to give you some inspiration for your profile README.įor a summary of all the available emojis and their codes, see " Emoji cheat sheet." Removing a profile README Select Initialize this repository with a README.Ībove the right sidebar, click Edit README. Optionally, in the "Description" field, type a description of your repository. For example, if your username is "octocat", the repository name must be "octocat". Under "Repository name", type a repository name that matches your GitHub username. In the upper-right corner of any page, use the drop-down menu, and select New repository. You can manually share the repository's README to your profile by going to the repository on and clicking Share to profile.

Note: If you created a public repository with the same name as your username before July 2020, GitHub won't automatically show the repository's README on your profile. The README.md file contains any content.The repository contains a file named README.md in its root.You've created a repository with a name that matches your GitHub username.GitHub will display your profile README on your profile page if all of the following are true. For more information, see " Getting started with writing and formatting on GitHub." For a hands-on guide to customizing your profile README, see " Quickstart for writing on GitHub." Prerequisites

You can format text and include emoji, images, and GIFs in your profile README by using GitHub Flavored Markdown.

GitHub shows your profile README at the top of your profile page. You can share information about yourself with the community on by creating a profile README.
