Create a README for your enterprise

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

本文内容

About READMEs for enterprises

为了帮助人们了解你的企业正在发生的事情，应该创建一个 README。 例如，可以使用 README 帮助成员了解企业中的不同组织、共享重要资源的链接或交流有关企业设置和策略的信息。

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 自定义组织的配置文件.

Creating a README for an enterprise

  1. 在 GitHub 的右上角，单击你的个人资料照片。

  2. 根据环境，单击“你的企业”，或单击“你的企业”，然后单击要查看的企业********。

  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 基本撰写和格式语法.

    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