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

Enterprise での変更等をメンバーと共有するために README を作成する必要があります。 たとえば、README を使用すると、メンバーが Enterprise 内のさまざまな Organization について学習したり、重要なリソースへのリンクを共有したり、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 Organizationのプロフィールのカスタマイズ.

Creating a README for an enterprise

  1. GitHub の右上隅にあるプロフィール写真をクリックします。

  2. ご自分の環境に応じて、[Your enterprise] または [Your enterprises] をクリックし、表示するエンタープライズをクリックします。

  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