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

사용자가 엔터프라이즈에서 무슨 일이 벌어지는지 이해하도록 돕기 위해 추가 정보를 생성하면 좋습니다. 예를 들어 추가 정보를 사용해 구성원이 엔터프라이즈 내 여러 조직에 관해 알아보도록 도울 수 있고, 중요한 리소스 링크를 공유할 수도 있으며, 아니면 엔터프라이즈 설정이나 정책에 관한 정보를 알릴 수도 있습니다.

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