Create a public GitHub repository named exactly after your username, add a non-empty README.md at its root, and commit your introduction. GitHub displays that README at the top of your profile when those conditions are met.
What you need before you start
- A GitHub account with a user profile. Managed user accounts cannot use profile READMEs.
- A public repository whose name exactly matches your GitHub username.
- A non-empty file named
README.mdin the repository root.
All of these conditions must be true for GitHub to show the README on your profile. See GitHub’s profile README guide for the documented requirements.
As an Amazon Associate I earn from qualifying purchases.
Create the profile README
- Sign in to GitHub and select New repository.
- Enter your exact GitHub username as the repository name. Match the spelling and capitalization shown for your account.
- Choose Public, then select the option to initialize the repository with a README.
- Create the repository. Open
README.mdand select Edit README. - Replace the generated starter text—often beginning with “### Hi there”—with your own introduction.
- Select Preview to check the rendered page, then commit the changes when you are ready.
GitHub’s profile setup guide suggests examples such as what you work on, interests, contributions you are proud of, selected projects, or communities where people can find help. These are ideas, not mandatory sections.
Choose when the update becomes visible
Committing directly to the main branch makes the changes visible to visitors on your profile. If you want to review the change before it appears there, create a branch, commit your edit to that branch, and open a pull request; merging it publishes the update. GitHub’s writing quickstart describes both workflows.
#1 Best Overall
Format the README for profile visitors
GitHub supports GitHub Flavored Markdown in profile READMEs. Use headings and lists to make the content easy to scan, and link to selected work rather than trying to put every detail on the profile page. GitHub’s Markdown writing guide also demonstrates HTML for images, including a <picture> element with light- and dark-mode image sources, alt text, and hidden HTML comments. Check the result in Preview.
For images or other files stored in the same repository, use relative paths. GitHub recommends this approach because it adapts links to the branch being viewed and works better in repository clones than links tied to a fixed location. See GitHub’s README documentation.
Edit an existing profile README
If you already have one, open your profile and use the edit control next to the profile README. Make your changes, preview them, and commit using the workflow that suits your review needs.
Quick wins for a faster PC:
Scan for outdated or missing drivers - takes under a minuteDriver Scan →Clear out junk files and repair common Windows errorsFree Scan →Check visibility and fix common problems
- The README is missing from your profile: Check that the repository is public, its name matches your username, and a non-empty
README.mdis in the repository root. - The repository is old: If the matching public repository was created before July 2020, open it and select Share to profile if that option is needed.
- The README stopped appearing: GitHub no longer displays it if the file is deleted or emptied, the repository becomes private, or the repository name no longer matches your username.
- Only part of the README renders: GitHub truncates repository README content beyond 500 KiB in its rendered view. Keep the profile introduction focused and link to longer project documentation where useful.
A public profile is visible to all GitHub users, not just people you know or followers. Consider carefully which personal details you share; GitHub notes that local laws, regulations, or cultural norms can make identity expression risky in some places. See GitHub’s profile visibility information.
Quick Recap
Best Value
Product prices and availability are accurate as of the date/time indicated and are subject to change. Any price and availability information displayed on Amazon at the time of purchase will apply.
