Diese Version von GitHub Enterprise wurde eingestellt am 2021-09-23. Es wird keine Patch-Freigabe vorgenommen, auch nicht für kritische Sicherheitsprobleme. Für eine bessere Leistung, verbesserte Sicherheit und neue Features nimm ein Upgrade auf die neueste Version von GitHub Enterprise vor. Wende Dich an den GitHub Enterprise-Support, um Hilfe beim Upgrade zu erhalten.

Managing your profile README

You can add a README to your GitHub profile to tell other people about yourself.

About your profile README

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

You decide what information to include in your profile README, so you have full control over how you present yourself on GitHub. Here are some examples of information that visitors may find interesting, fun, or useful in your profile README.

  • An "About me" section that describes your work and interests
  • Contributions you're proud of, and context about those contributions
  • Guidance for getting help in communities where you're involved

Profile README file displayed on profile

You can format text and include emoji, images, and GIFs in your profile README by using GitHub Flavored Markdown. Weitere Informationen findest Du unter „Erste Schritte zum Schreiben und Formatieren auf GitHub“.


GitHub will display your profile README on your profile page if all of the following are true.

  • You've created a repository with a name that matches your GitHub username.
  • The repository is public.
  • The repository contains a file named README.md in its root.
  • The README.md file contains any content.

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. You can manually share the repository's README to your profile by going to the repository on GitHub.com and clicking Share to profile.

Button to share README to profile

Adding a profile README

  1. Benutze in der oberen rechten Ecke einer beliebigen Seite das -Dropdownmenü und wähle New Repository (Neues Repository). Dropdownmenü mit der Option, ein neues Repository zu erstellen

  2. Under "Repository name", type a repository name that matches your GitHub username. For example, if your username is "octocat", the repository name must be "octocat". Repository name field which matches username

  3. Optional kannst Du auch eine Beschreibung des Repositorys hinzufügen. For example, "My personal repository." Feld zum Eingeben einer Repository-Beschreibung

  4. Select Public. Radio button to select visibility with public selected

  5. Wähle Initialize this repository with a README (Dieses Repository mit einer README-Datei initialisieren). Kontrollkästchen „Initialize this repository with a README“ (Dieses Repository mit einer README-Datei initialisieren)

  6. Klicke auf Create repository (Repository erstellen). Button to create repository

  7. Above the right sidebar, click Edit README. Button to edit README file

    The generated README file is pre-populated with a template to give you some inspiration for your profile README. README file with pre-populated template

For a summary of all the available emojis and their codes, see "Emoji cheat sheet."

Removing a profile README

The profile README is removed from your GitHub profile if any of the following apply:

  • The README file is empty or doesn't exist.
  • The repository is private.
  • The repository name no longer matches your username.

The method you choose is dependant upon your needs, but if you're unsure, we recommend making your repository private. For steps on how to make your repository private, see "Changing a repository's visibility."

Weiterführende Informationen