Create a README for your enterprise

You can create a README to communicate important information and resources with members in your enterprise.

In diesem Artikel

About READMEs for enterprises

Sie sollten eine Infodatei erstellen, damit Ihre Benutzer verstehen, was in Ihrem Unternehmen passiert. Sie können z. B. eine Infodatei verwenden, um Mitgliedern zu helfen, sich über verschiedene Organisationen im Unternehmen zu informieren, um Links zu wichtigen Ressourcen zu teilen oder um Informationen über die Einstellungen und Richtlinien Ihres Unternehmens zu vermitteln.

The README is displayed on the enterprise's "Overview" page, which is the landing page you see when you navigate to the enterprise. This page is only visible to members of the enterprise.

You can also create READMEs for organizations in your enterprise, visible either publicly or only to members. For more information, see Anpassen des Profils deiner Organisation.

Creating a README for an enterprise

  1. Klicke auf GitHub in der oberen rechten Ecke auf dein Profilfoto.

  2. Klicke je nach deiner Umgebung auf Dein Unternehmenoder auf Deine Unternehmen, und klicke dann auf das Unternehmen, das du anzeigen möchtest.

  3. On the "Overview" page, click Create README. If a README is already present on the page, click Edit.

  4. Write the content for your README. You can use Markdown to format the content, such as adding headings, images, and lists. For more information, see Grundlegende Schreib- und Formatierungssyntax.

    Note

    You can only link to publicly hosted images in your README. You cannot upload an image to your README, or link to an image from a private repository.

  5. Click Save.

Further reading