Creating a README for an enterprise

You can create a README to tell your members what is happening in your enterprise.

Who can use this feature?

Enterprise owners can create and edit an enterprise README.

In this article

About READMEs for enterprises

To help people understand what is happening in your enterprise, you should create a README. For example, you can use a README to help members learn about different organizations in the enterprise, to share links to important resources, or to communicate information about the settings and policies of your enterprise.

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 Customizing your organization's profile.

Creating a README for an enterprise

  1. In the top-right corner of GitHub Enterprise Server, click your profile photo, then click Enterprise settings.

    Screenshot of the drop-down menu that appears when you click the profile photo on GitHub Enterprise Server. The "Enterprise settings" option is highlighted in a dark orange outline.

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

  3. 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 Basic writing and formatting syntax.

    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.

  4. Click Save.

Further reading