Skip to content
Ben Forbes Griffith edited this page Apr 3, 2024 · 3 revisions

GitHub profile README.md

To display a README.md on your GitHub profile page, ensure the following:

  • Create a repository with a name that matches your GitHub username, which will result in a repository at this URL pattern: https://github.com/GitHubUSERNAME/GitHubUSERNAME/
  • Ensure the repository is public.
  • Create a file named README.md at the root of the repository.
  • Put in that README.md file whatever Markdown or HTML you wish to display on your GitHub profile page!

This wiki is full of hopefully helpful tips&links for creating an awesome GitHub profile! Peruse the links in the footer or Right‑sidebar index to access these more detailed examples&tutorials.